Skip to content

[Feature] Harden release checklist and post-release verification #120

@Astro-Han

Description

@Astro-Han

Summary

Improve the PawWork release process so future releases are easier to run and verify.

Scope

  • Add a tracked release checklist.
  • Require release notes before publishing a GitHub Release.
  • Add post-release verification for user-facing downloads and updater metadata.
  • Script or document the release workflow commands to reduce manual copy/paste mistakes.

Checklist Location

Add the reusable checklist at .github/RELEASE_CHECKLIST.md.

docs/ is local-only in this repo, so it is not a good place for tracked release process docs. .github/ is better because this is GitHub Release and Actions workflow guidance.

Release Notes Format

Document the v0.2.5 format as the default:

  • English first.
  • Direct Downloads links for the user-facing installers.
  • A short Chinese section below the English notes.
  • Do not rely on the GitHub Assets list as the primary download UI.

Post-Release Verification

The release checklist or helper should verify:

  • The GitHub Release is not a draft.
  • The GitHub Release is not a prerelease for stable channels.
  • The macOS Apple Silicon .dmg exists.
  • The macOS Intel .dmg exists.
  • The Windows x64 .exe exists.
  • latest.yml points to the Windows installer.
  • latest-mac.yml includes both macOS arm64 and x64 update entries.

Non-Goals

  • Do not repair v0.2.5 latest-mac.yml; ship the fixed updater metadata path in the next release.
  • Do not remove .zip, .blockmap, or latest*.yml assets until updater requirements are proven safe.
  • Do not redesign the release workflow beyond the checklist, verification, and command-helper scope.

Acceptance Criteria

  • .github/RELEASE_CHECKLIST.md exists and covers version bump, PR merge, workflow runs, release notes, publish step, post-release checks, and issue closeout.
  • The checklist documents the English-first plus Chinese-summary release notes format.
  • A post-release verification path exists, either as a script or as exact commands in the checklist.
  • The release workflow command sequence for macOS submit/finalize and Windows full builds is scripted or documented enough to avoid manual parameter mistakes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Medium priorityenhancementNew feature or requestplatformElectron shell, OS integration, packaging, updater, signing, paths, and permissions

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions