| name | release |
| description | Repository-scoped release instructions for keypunch. Use this when the user asks to cut a release, create or push a tag, watch the Release workflow, run a validation build, or verify the Sparkle appcast for this repository. Releases are tag-driven, so do not create a version bump commit just to publish a release. |
| allowed-tools | ["Bash","Read","Grep","Glob"] |
| metadata | {"short-description":"Tag-driven release workflow for keypunch"} |
keypunch Release
The canonical reference is the release section in README.md. If the skill and
the README diverge, update the README first and then align this skill.
When to use
- Cut a keypunch release
- Run the
Release workflow manually for validation
- Verify Sparkle, GitHub Release, and Homebrew release artifacts
Release
- Confirm the release changes are already merged to
main and the Test
workflow is green.
- Choose
VERSION and push the release tag.
VERSION=0.0.10
git tag "v${VERSION}"
git push origin "v${VERSION}"
- Watch the
Release workflow.
gh run list --workflow Release --limit 5
gh run watch
- Verify the published artifacts.
gh release view "v${VERSION}"
curl -fsSL https://mkusaka.github.io/keypunch/appcast.xml | rg "<sparkle:shortVersionString>${VERSION}</sparkle:shortVersionString>"
Expected results:
Keypunch.zip is attached to the GitHub Release- the matching version is present in
gh-pages/appcast.xml
- the
repository_dispatch to mkusaka/homebrew-tap succeeded inside the
release workflow
Validation Build
Use workflow_dispatch when you want to validate signing, notarization, and
export without publishing a release.
gh workflow run Release --field version=0.0.10
gh run list --workflow Release --limit 5
gh run watch
This run does not create a GitHub Release, dispatch Homebrew updates, or update
gh-pages.
Notes
- The release version comes from the tag name. Do not create a version bump
commit just to publish a release.
- The machine-readable Sparkle version is derived inside the workflow as
major * 10000 + minor * 100 + patch.
