Memex release
A full release is: version bump and tag via cargo release, the tag-triggered
GitHub release workflow, the locally signed macOS app plus its Homebrew cask,
then verification. The repo owns the mechanics; when this file disagrees with
them, trust release.toml, .github/workflows/release.yml,
scripts/release_macos_local.sh, and apps/macos/scripts/publish-cask.sh.
Before starting
- Release from the maintainer's main checkout on
main, not from a worktree:cargo releaserefuses a detached HEAD. - Preserve unrelated working-tree changes; the macOS script requires a clean tree.
- Pick the bump from the commits since the latest tag
(
git log --oneline $(git describe --tags --abbrev=0)..origin/main): fixes only -> patch, new user-visible capability -> minor, breaking change -> major. A requested bump does not override contrary evidence; say which you chose and why. - CI on the latest
maincommit must be green. If it is still running, wait for that exact commit.
Procedure
- Sync:
git fetch origin --prune --tags && git pull --ff-only. - Check:
cargo fmt --check,mbx clippy -- -D warnings, andmbx testonce. If the full suite stalls or a known timing-sensitive test fails, rerun that test alone and report the full suite as unverified rather than passed. - Bump and tag:
cargo release <bump> --execute --no-confirm. This updatesCargo.toml,Cargo.lock, andherdr-plugin.toml, commits "Release memex version X.Y.Z", tagsvX.Y.Z, and pushes both. It does not publish to crates.io. Run it once without--executefirst if unsure. - Release workflow (
release.yml, triggered by the tag): buildsmemex-X.Y.Z-macos-arm64.tar.gzandmemex-X.Y.Z-linux-{x86_64,arm64}.tar.gz(each with.sha256) plus the Qt AppImage, and creates the GitHub release. Watch it withgh run list --workflow release.ymland one bounded wait. - macOS app, after the GitHub release exists (needs the maintainer's local
Developer ID and notarization setup):
CODESIGN_IDENTITY='<Developer ID Application identity>' scripts/release_macos_local.sh X.Y.Z(NOTARY_PROFILEhas a default in the script). It builds, signs, notarizes, staples, uploadsmemex-app-X.Y.Z-macos-arm64.zip, and updatesCasks/memex-app.rbinnicosuave/homebrew-tap. Run it in the background; it takes minutes. On an upload or cask failure, retry with--publish-only X.Y.Z. - Homebrew formula:
memexlives in homebrew-core (the tap'stap_migrations.jsonpoints there). Nothing to push; verify withgh api repos/Homebrew/homebrew-core/contents/Formula/m/memex.rb --jq .content | base64 --decode. It usually lags the tag; report it as pending rather than failed.
Verify
gh release view vX.Y.Z --repo nicosuave/memex --json isDraft,isPrerelease,assets: not draft or prerelease, and has the CLI archives, AppImage, and app zip, each with.sha256.- Download one archive, check it with
shasum -a 256 -c, extract it, and confirmmemex --versionprintsmemex X.Y.Z. - The tap cask shows the new version; the homebrew-core formula shows it or is reported as pending.
- The main checkout ends clean and in sync with
origin/main.
Pitfalls
gh release viewdoes not supportisLatest; useisDraftandisPrerelease.- If Homebrew needs a newer OpenSSL, update the locked
opensslandopenssl-syscrates together before releasing (openssl-sys 0.9.111rejects OpenSSL >= 4). brew lgtm <formula>can fail; runHOMEBREW_NO_AUTO_UPDATE=1 HOMEBREW_NO_INSTALL_FROM_API=1 brew lgtm --onlinewithout a formula argument from a homebrew-core checkout.
