SPB Git

Repository Public License

runbook.md 3.4 KB 66 lines markdown

1<!--2ORIX OS Automation3File: docs/release/runbook.md4Author: Simon-Pierre Boucher5Contact: contact@spboucher.ai6-->7# Release and notarization runbook89Distribution is direct (Developer ID + notarization). The app is not sandboxed; it uses the Hardened Runtime and10one entitlement, `com.apple.security.automation.apple-events`.1112## Prerequisites on the build Mac1314- Xcode with the macOS SDK, `xcodegen`, `create-dmg`.15- A **Developer ID Application** identity in the login keychain (`security find-identity -v -p codesigning`).16- A notarytool keychain profile. The scripts use `NOTARY_PROFILE` (default `MacLustr-Notarize`) and never create,17  print or modify credentials. Check it answers: `xcrun notarytool history --keychain-profile "$NOTARY_PROFILE"`.1819## Steps2021```bash22# 1. Version: edit MARKETING_VERSION / CURRENT_PROJECT_VERSION in project.yml, update CHANGELOG.md23# 2. Everything in one command:24Scripts/release/release.sh25```2627`release.sh` stops at the first failure and does, in order:28291. `Scripts/test/test-all.sh` — every package; writes `docs/release/test-report.json`.30   (Run it under `Scripts/test/with-dev-keys.sh` beforehand to include the live provider suites.)312. `Scripts/check-headers.sh`.323. `Scripts/build/build.sh release` — XcodeGen, Release build (arm64 + x86_64), Developer ID signing with a secure33   timestamp, into `dist/ORIX OS Automation.app`.344. `Scripts/release/secret-scan.sh "dist/ORIX OS Automation.app"` — fails on credential-shaped strings in the35   repository, its history or the bundle; on the development credential adapter being present in the binary; on36   internal host names.375. `Scripts/release/sign.sh` — verifies identity, Hardened Runtime, timestamp, bundle identifier, deep signature,38   and that no debug entitlement is present.396. `Scripts/release/notarize.sh <app> app` — `notarytool submit --wait`; on `Accepted`, staples. Anything else40   stops the release and leaves Apple's log in `build/notary/app-log.json`.417. `Scripts/release/package.sh all` — ZIP and a signed DMG.428. `Scripts/release/notarize.sh <dmg> dmg` — notarizes and staples the disk image.439. Checksums, `spctl` assessment of the app and the DMG.4410. Writes `docs/release/release-<version>-<build>.md` from the tools' own output (signature, architectures,45    entitlements, submission ids and statuses, staple validation, Gatekeeper verdicts, SHA-256).4647"Notarized" is only ever printed after Apple answered `Accepted`.4849## After the build5051- Open the DMG on another Mac or another user account: drag to Applications, launch, go through the welcome52  guide, confirm the Keychain item is created on key entry, enable and disable the background agent, quit.53- Publish the DMG, the ZIP, `SHA256SUMS.txt` and the release notes together.5455## If notarization is rejected5657Read `build/notary/<name>-log.json`. Usual causes: an unsigned or ad-hoc-signed nested binary, a missing secure58timestamp, the Hardened Runtime disabled on a helper, a debug entitlement (`get-task-allow`). Fix the cause and59run the release again; never disable the Hardened Runtime or strip the signature check to get through.6061## Updates6263This version has no automatic updater. Sparkle 2 (EdDSA-signed appcasts, the installer running as an XPC64service) is the candidate; it would be the first third-party dependency and needs its own review before it is65added. Until then, updates are installed by replacing the app from a new notarized DMG.66
Files main
Menu

Theme