Skip to content

RELEASING.md

Latest commit

 

History

History
61 lines (46 loc) · 2.37 KB

RELEASING.md

File metadata and controls

61 lines (46 loc) · 2.37 KB
Raw

Release process

OverflowBar uses semantic version tags and publishes installable DMGs plus Sparkle ZIP/appcast assets through GitHub Releases. The DMG remains the primary manual distribution path; the ZIP is the in-app update payload and the third-party Homebrew Cask mirrors the DMG.

Cadence

  • Patch release: focused compatibility, capture, activation, or packaging fixes
  • Minor release: a user-visible capability or meaningful workflow improvement
  • Major release: an incompatible preference, architecture, or product-direction change

There is no release solely to satisfy a calendar. Important fixes should be released promptly; routine improvements are grouped into coherent updates.

Checklist

  1. Update CFBundleShortVersionString and increase CFBundleVersion in OverflowBar/Resources/Info.plist.

  2. Update Casks/overflowbar.rb with the release version and the SHA-256 of the matching DMG.

  3. Move user-visible changes into CHANGELOG.md and update RELEASE_NOTES.md.

  4. Build Debug and Release configurations.

  5. Run live checks:

    • arrow is present
    • selected third-party items are managed
    • protected system items remain visible
    • second row opens and closes
    • direct and temporary-reveal activation work
    • Safe Reset and normal quit restore the layout

  6. Build and verify the DMG and updater ZIP:

    ./scripts/create-dmg.sh
hdiutil verify dist/OverflowBar-<version>.dmg
shasum -a 256 -c dist/OverflowBar-<version>.dmg.sha256

    The release workflow also generates and signs dist/appcast.xml using the SPARKLE_ED_KEY GitHub Actions secret. Keep the private key out of the repository and publish only the public key in Info.plist.

  7. Validate the Homebrew Cask metadata:

    bash scripts/validate-homebrew-cask.sh

  8. Commit and push the release source.

  9. Tag the exact release commit:

    git tag v<version>
git push origin v<version>

The tag triggers .github/workflows/release.yml, which validates version parity and monotonic build numbers, builds the DMG and updater ZIP, generates the signed appcast, and creates the GitHub Release with all updater assets.

Signing

scripts/create-dmg.sh uses DEVELOPER_ID_APPLICATION when provided. Without it, the script creates an ad-hoc signed community build. Notarization must be added before describing a release as Gatekeeper-ready.