imsg/docs/RELEASING.md

Releasing

Release notes source

• GitHub Release notes come from CHANGELOG.md for the matching version section (## X.Y.Z - YYYY-MM-DD).
• Keep ## Unreleased at the top (empty is fine).

Steps

1. Update CHANGELOG.md and version
   • Move entries from Unreleased into a new ## X.Y.Z - YYYY-MM-DD section.
   • Credit contributors (e.g. thanks @user).
   • Update version.env to X.Y.Z.
   • Run scripts/generate-version.sh (also refreshes Sources/imsg/Resources/Info.plist).
2. Ensure CI is green on main
   • make lint
   • make test
   • make format (optional, if formatting changes are expected)
3. Build, sign, and notarize
   • Requires APP_STORE_CONNECT_API_KEY_P8, APP_STORE_CONNECT_KEY_ID, APP_STORE_CONNECT_ISSUER_ID.
   • scripts/sign-and-notarize.sh (outputs /tmp/imsg-macos.zip by default)
   • Verify the zip contains required SwiftPM bundles (e.g. PhoneNumberKit_PhoneNumberKit.bundle).
   • Verify entitlements/signing:
     • unzip -q /tmp/imsg-macos.zip -d /tmp/imsg-check
     • codesign -d --entitlements :- /tmp/imsg-check/imsg
     • spctl -a -t exec -vv /tmp/imsg-check/imsg
4. Tag, push, and publish
   • git tag -a vX.Y.Z -m "vX.Y.Z"
   • git push origin vX.Y.Z
   • gh release create vX.Y.Z /tmp/imsg-macos.zip -t "vX.Y.Z" -F /tmp/release-notes.txt
   • gh release edit vX.Y.Z --notes-file /tmp/release-notes.txt (if needed)

What happens in CI

• Release signing + notarization are done locally via scripts/sign-and-notarize.sh.
• .github/workflows/release.yml is only for manual rebuilds, not the primary release path.