Add instructions for tagging and GitHub releases

Updated SKILL.md and release.md to include steps for creating a git tag and publishing a GitHub release with the app zip and appcast. This provides clearer guidance for distributing releases via GitHub.
This commit is contained in:
Thomas Ricouard 2026-01-07 12:38:14 +01:00
parent f07d884c74
commit fd1375e2ad
2 changed files with 18 additions and 0 deletions

View file

@ -20,6 +20,7 @@ Bootstrap a complete SwiftPM macOS app folder, then build, package, and run it w
- Package: `Scripts/package_app.sh`.
- Run: `Scripts/compile_and_run.sh` (preferred) or `Scripts/launch.sh`.
- Release (optional): `Scripts/sign-and-notarize.sh` and `Scripts/make_appcast.sh`.
- Tag + GitHub release (optional): create a git tag, upload the zip/appcast to the GitHub release, and publish.
## Templates
- `assets/templates/package_app.sh`: Build binaries, create the .app bundle, copy resources, sign.

View file

@ -12,3 +12,20 @@
- Install Sparkle tools so `generate_appcast` is on PATH.
- Provide `SPARKLE_PRIVATE_KEY_FILE` (ed25519 key).
- The appcast script uses your zip artifact to create an updated `appcast.xml`.
## Tag and GitHub release (optional)
Use a versioned git tag and publish a GitHub release with the notarized zip (and appcast if you host it on GitHub Releases).
Example flow:
```
git tag v<version>
git push origin v<version>
gh release create v<version> CodexBar-<version>.zip appcast.xml \
--title "AppName <version>" \
--notes-file CHANGELOG.md
```
Notes:
- If you serve appcast from GitHub Releases or raw URLs, ensure the release is published and assets are accessible (no 404s).
- Prefer using a curated release notes file rather than dumping the full changelog.