Skip to content

Releasing ​

Releases are cut by release-please. Every merge to main updates an open release pull request with the next version and its changelog, worked out from the conventional commit messages. Merging that pull request tags the release, and the Binaries workflow attaches the builds to it:

PlatformFile
Linux on amd64, arm64 and arminterlock-<version>-linux-<arch>.tar.gz
macOS on Apple silicon and Intelinterlock-<version>-darwin-<arch>.tar.gz
Windows on x64interlock-<version>-windows-amd64.zip

A checksums file lists the SHA-256 of each. Never bump versions by hand.

To try the build without releasing anything, open the Binaries workflow on the repository's Actions tab and choose Run workflow. The dry run keeps the archives as a workflow artifact named release-files.

Signing ​

macOS and Windows warn about programs downloaded in a browser unless the program is signed by an identified developer. macOS refuses to open an unnotarized download until its quarantine flag is cleared, and Windows SmartScreen shows "Windows protected your PC". The Binaries workflow signs each platform's build once that platform's credentials are in the repository settings. Until then the build ships unsigned and Getting started tells people how to run it anyway. A dry run shows whether new credentials work before a release depends on them.

macOS: Developer ID and notarization ​

This needs a membership in the Apple Developer Program, which costs $99 a year.

  1. Create a Developer ID Application certificate in the developer account or in Xcode's account settings. Export it from Keychain Access as a .p12 file with a password.
  2. In App Store Connect, under Users and Access, then Integrations, create a team API key with Developer access and download its .p8 file.
  3. Add these repository secrets:
SecretValue
APPLE_CERTIFICATEthe .p12 file in base64: base64 -i cert.p12
APPLE_CERTIFICATE_PASSWORDthe .p12 file's password
APPLE_NOTARY_KEYthe contents of the .p8 file
APPLE_NOTARY_KEY_IDthe API key's ID
APPLE_NOTARY_ISSUERthe issuer ID shown above the list of keys

The workflow signs both macOS binaries with the hardened runtime and sends them to Apple's notary service. A bare executable cannot carry the notarization ticket, so macOS checks with Apple online the first time the program runs.

Windows: Azure Artifact Signing ​

This needs an Azure subscription and an Artifact Signing account, which bills monthly.

  1. Create an Artifact Signing account, complete identity validation for public trust, and create a certificate profile.
  2. Create an app registration with a client secret, and give it the Artifact Signing Certificate Profile Signer role on the account.
  3. Add these repository secrets and variables:
SecretValue
AZURE_TENANT_IDthe directory (tenant) ID
AZURE_CLIENT_IDthe app registration's client ID
AZURE_CLIENT_SECRETthe client secret
VariableValue
AZURE_SIGNING_ENDPOINTthe account's region endpoint, such as https://eus.codesigning.azure.net/
AZURE_SIGNING_ACCOUNTthe Artifact Signing account name
AZURE_CERTIFICATE_PROFILEthe certificate profile name

A newly signed program can still meet the SmartScreen prompt until enough people have run it, but the prompt names you as the publisher instead of "Unknown publisher". SignPath Foundation signs open source projects for free after an application, and would replace the Azure step in the workflow.

GPL-3.0 licensed.