Skip to content

RELEASING.md

Latest commit

 

History

History
46 lines (30 loc) · 3.12 KB

RELEASING.md

File metadata and controls

46 lines (30 loc) · 3.12 KB
Raw

Releasing FS Code

The application targets macOS 15+. build-app.sh builds for the host architecture; the first alpha artifact is for Apple Silicon (arm64), not a universal binary.

Local build

bash scripts/build-app.sh

This defaults to ad-hoc signing for development. No RTK installation is required.

Developer ID distribution

Install your Developer ID Application certificate/private key in your macOS Keychain. Store notarization credentials using Apple's xcrun notarytool store-credentials interactive workflow. Never put private keys or passwords in the repository.

export FS_CODE_SIGN_IDENTITY="Developer ID Application: Your Name (TEAMID)"
# Optional: restrict codesign identity lookup to one keychain.
export FS_CODE_SIGN_KEYCHAIN="/path/to/selected.keychain-db"
export FS_CODE_NOTARY_PROFILE="your-notary-profile"
bash scripts/release-sign.sh

FS_CODE_SIGN_IDENTITY may also be an unambiguous certificate hash. Set FS_CODE_SIGN_KEYCHAIN only when identity lookup must be restricted to a specific keychain; the script does not choose one by default. The script signs nested Sparkle components, the framework, and the application with hardened runtime and a secure timestamp. The application signature seals the SwiftTerm resource bundle. It then creates an architecture-specific ZIP, submits it to Apple, staples the ticket, and recreates the ZIP. If FS_CODE_NOTARY_PROFILE is omitted, the artifact is signed but not notarized.

Verify before publishing:

codesign --verify --deep --strict "dist/FS Code.app"
xcrun stapler validate "dist/FS Code.app"
spctl --assess --type execute --verbose=2 "dist/FS Code.app"
shasum -a 256 dist/release/*.zip

Run relevant tests and launch the signed app. Publish source matching the binary, release notes, architecture/minimum system version, and a checksum. Mark alpha releases as prereleases. Increment the bundle build number for subsequent releases.

Updates

Version 0.1.1 activates the public feed at https://raw.githubusercontent.com/gitlares/fs-code/main/updates/appcast.xml. Version 0.1.0 needs one manual upgrade. Automatic update checks and installation remain disabled by default.

The checked-in plist includes the feed and public key. To override them for a build, supply both FS_CODE_SU_FEED_URL (HTTPS) and FS_CODE_SU_PUBLIC_ED_KEY (Base64 Ed25519 public key). Keep the private update key outside source control. Generate a signed appcast using Sparkle's official tooling and test an upgrade between two actual releases before advertising automatic updates.

Developer ID signing and Sparkle update signing are distinct. A notarized application alone does not establish an update channel.

The production Sparkle key is held in Keychain under account fs-code. Never export its private key into this repository. After notarization and stapling, generate the appcast with the bundled Sparkle tool using --account fs-code --download-url-prefix https://github.com/gitlares/fs-code/releases/download/TAG/. Publish the release archive before pushing updates/appcast.xml. Verify the published ZIP hash and feed enclosure signature. Never change an archive after signing it.