#!/bin/bash set +x set +v set -euo pipefail cd "$(dirname "$0")/.." # shellcheck source=Scripts/product.env source Scripts/product.env source Scripts/version.sh source Scripts/packaging-paths.sh umask 077 fail() { printf '%s\n' "$*" >&2; exit 1; } [[ $# == 1 && $1 =~ ^(preflight|build|sign|publish)$ ]] || { printf 'Usage: %s preflight|build|sign|publish\n' "$0" >&2; exit 2; } [[ ${GITHUB_ACTIONS:-} == true && ${GITHUB_EVENT_NAME:-} == workflow_dispatch && ${GITHUB_REF_TYPE:-} == branch ]] || fail 'Releases require a GitHub Actions dispatch on the default branch.' [[ ${RUNNER_ENVIRONMENT:-} == github-hosted ]] || fail 'Releases require a GitHub-hosted runner.' [[ ${GITHUB_REPOSITORY:-} == "$PRODUCT_GITHUB_REPO" ]] || fail 'Refusing a release outside the expected mirror repository.' [[ ${GITHUB_REF:-} == "refs/heads/$PRODUCT_DEFAULT_BRANCH" && ${GITHUB_REF_NAME:-} == "$PRODUCT_DEFAULT_BRANCH" ]] || fail 'Release workflows must run on the default branch.' [[ ${RELEASE_TAG:-} == v* ]] || fail 'Release tags must start with v.' version=${RELEASE_TAG#v} validate_ordered_version "$version" || fail 'Release tags must be vMAJOR.MINOR.PATCH.' validate_positive_build_number "${GITHUB_RUN_NUMBER:-}" || fail 'A positive GitHub run number is required.' [[ $PRODUCT_ENV_PREFIX =~ ^[A-Z][A-Z0-9_]*$ ]] || fail 'Invalid product environment prefix.' [[ $PRODUCT_RELEASE_ARTIFACT =~ ^[A-Za-z0-9_-]+$ && $PRODUCT_CASK =~ ^[a-z0-9-]+$ ]] || fail 'Invalid artifact or cask name.' [[ $(git rev-parse HEAD) == "$(git rev-parse "origin/$PRODUCT_DEFAULT_BRANCH")" ]] || fail 'Release scripts require the trusted default-branch checkout.' packaging_build_directory output="build/releases/$version" dmg="$output/$PRODUCT_NAME-$version.dmg" release_commit=$(Scripts/parcel-dev.sh release-order provenance "$PWD" "$RELEASE_TAG" "origin/$PRODUCT_DEFAULT_BRANCH") || fail 'Release tag must be an ancestor of the default branch.' if [[ $1 == preflight ]]; then : "${GITHUB_OUTPUT:?GitHub step output file is required}" : "${GITHUB_STEP_SUMMARY:?GitHub job summary file is required}" : "${GH_TOKEN:?GitHub read token is required for release history}" subject=$(git show -s --format=%s "$release_commit") touch "$GITHUB_STEP_SUMMARY" Scripts/parcel-dev.sh release-summary "$GITHUB_STEP_SUMMARY" "$RELEASE_TAG" "$release_commit" "$subject" Scripts/parcel-dev.sh release-order preflight "$PWD" "$RELEASE_TAG" "$GITHUB_RUN_NUMBER" "$PRODUCT_GITHUB_REPO" "origin/$PRODUCT_DEFAULT_BRANCH" >/dev/null printf 'trusted=true\ncommit=%s\nartifact=%s\ndirectory=%s\ncask=%s\n' "$release_commit" "$PRODUCT_RELEASE_ARTIFACT" "$output" "$PRODUCT_CASK" >> "$GITHUB_OUTPUT" exit 0 fi [[ ${RELEASE_COMMIT:-} == "$release_commit" ]] || fail 'Release tag no longer matches the preflight commit.' value() { local name="${PRODUCT_ENV_PREFIX}_$1"; printf '%s' "${!name:-}"; } set_value() { export "${PRODUCT_ENV_PREFIX}_$1=$2"; } [[ -n ${PRODUCT_UPDATE_PUBLIC_KEY:-} ]] || fail 'Commit the immutable update public key in Scripts/product.env before releasing.' [[ -z ${SPARKLE_PUBLIC_KEY:-} || $SPARKLE_PUBLIC_KEY == "$PRODUCT_UPDATE_PUBLIC_KEY" ]] || fail 'Sparkle public key differs from the committed product key.' set_value VERSION "$version" set_value BUILD_NUMBER "$GITHUB_RUN_NUMBER" set_value BUNDLE_ID "$PRODUCT_BUNDLE_ID" set_value APPCAST_URL "${PRODUCT_SITE_URL%/}/appcast.xml" set_value UPDATE_PUBLIC_KEY "$PRODUCT_UPDATE_PUBLIC_KEY" set_value DOWNLOAD_URL_PREFIX "https://github.com/$PRODUCT_GITHUB_REPO/releases/download/$RELEASE_TAG" set_value RELEASE_DIR "$output" check_artifacts() { local artifact for artifact in "$dmg" "$output/SHA256SUMS" "$output/appcast.xml" "$output/$PRODUCT_CASK.rb"; do [[ -s $artifact && ! -L $artifact ]] || fail "Missing or unsafe release artifact: $artifact" done [[ ! -e $output/DRY-RUN.txt ]] || fail 'Refusing to publish rehearsal artifacts.' Scripts/parcel-dev.sh release-checksum "$dmg" "$output/SHA256SUMS" } if [[ $1 == publish ]]; then : "${GH_TOKEN:?GitHub release token is required}" check_artifacts Scripts/parcel-dev.sh release-order preflight "$PWD" "$RELEASE_TAG" "$GITHUB_RUN_NUMBER" "$PRODUCT_GITHUB_REPO" "origin/$PRODUCT_DEFAULT_BRANCH" >/dev/null existing=$(gh release list --repo "$PRODUCT_GITHUB_REPO" --limit 1000 --json tagName,isDraft) state=$(Scripts/parcel-dev.sh release-state "$RELEASE_TAG" <<< "$existing") case $state in missing) gh release create "$RELEASE_TAG" --repo "$PRODUCT_GITHUB_REPO" --verify-tag --draft --title "$PRODUCT_NAME $version" --generate-notes ;; draft) [[ $(gh release view "$RELEASE_TAG" --repo "$PRODUCT_GITHUB_REPO" --json isDraft --jq '.isDraft') == true ]] || fail 'Release is no longer a draft.' ;; *) fail 'Published releases are immutable; never replacing their assets.' ;; esac [[ $(gh release view "$RELEASE_TAG" --repo "$PRODUCT_GITHUB_REPO" --json isDraft --jq '.isDraft') == true ]] || fail 'Release is no longer a draft.' gh release upload "$RELEASE_TAG" "$dmg" "$output/SHA256SUMS" "$output/appcast.xml" --repo "$PRODUCT_GITHUB_REPO" --clobber || fail 'Draft upload failed. Resume to finish the existing draft.' gh release edit "$RELEASE_TAG" --repo "$PRODUCT_GITHUB_REPO" --draft=false || fail 'Could not publish the completed draft. Resume after reviewing its state.' exit 0 fi if [[ $1 == build ]]; then for name in DEVELOPER_ID_P12 DEVELOPER_ID_PASSWORD DEVELOPER_ID_IDENTITY ASC_PRIVATE_KEY ASC_KEY_ID ASC_ISSUER_ID APPLE_TEAM_ID APPLE_ID APPLE_APP_PASSWORD SPARKLE_PRIVATE_KEY GH_TOKEN; do [[ -z ${!name:-} ]] || fail "Unsigned builds must not receive $name." done [[ ! -e build/unsigned && ! -L build/unsigned ]] || fail 'Refusing to replace unsigned artifacts.' set_value SIGN_IDENTITY - set_value ALLOW_ADHOC 1 source_checkout=${RELEASE_SOURCE:-$PWD} [[ $(git -C "$source_checkout" rev-parse HEAD) == "$release_commit" ]] || fail 'The build checkout must match the preflight release commit.' ( cd "$source_checkout" Scripts/bundle.sh release Scripts/check-bundle.sh --no-launch "build/$PRODUCT_NAME.app" ) mkdir -p build/unsigned COPYFILE_DISABLE=1 tar -czf build/unsigned/app.tar.gz -C "$source_checkout/build" "$PRODUCT_NAME.app" printf '%s\n' 'Unsigned build packaged; no signing secrets were available.' exit 0 fi [[ $(git rev-parse HEAD) == "$(git rev-parse "origin/$PRODUCT_DEFAULT_BRANCH")" ]] || fail 'Signing requires the trusted default-branch checkout.' output=$(packaging_output_path "$output") : "${RUNNER_TEMP:?GitHub runner temporary directory is required}" for name in DEVELOPER_ID_P12 DEVELOPER_ID_PASSWORD DEVELOPER_ID_IDENTITY ASC_PRIVATE_KEY ASC_KEY_ID ASC_ISSUER_ID APPLE_TEAM_ID SPARKLE_PRIVATE_KEY; do [[ -n ${!name:-} ]] || fail "Required release secret missing: $name" done [[ $DEVELOPER_ID_IDENTITY == 'Developer ID Application: '*" ($APPLE_TEAM_ID)" ]] || fail 'Signing identity must match the configured Developer ID team.' identity=$DEVELOPER_ID_IDENTITY p12=$DEVELOPER_ID_P12 p12_password=$DEVELOPER_ID_PASSWORD asc=$ASC_PRIVATE_KEY key_id=$ASC_KEY_ID issuer=$ASC_ISSUER_ID seed=$SPARKLE_PRIVATE_KEY unset DEVELOPER_ID_P12 DEVELOPER_ID_PASSWORD DEVELOPER_ID_IDENTITY ASC_PRIVATE_KEY ASC_KEY_ID ASC_ISSUER_ID APPLE_TEAM_ID SPARKLE_PRIVATE_KEY SPARKLE_PUBLIC_KEY work=$(mktemp -d "$RUNNER_TEMP/release-signing.XXXXXX") keychain="$work/signing.keychain-db" keychain_changed=false parse_keychains() { local line parsed_keychains=() while IFS= read -r line; do [[ $line =~ ^[[:space:]]*\"([^\"]+)\"[[:space:]]*$ ]] || fail 'Could not parse the existing keychain configuration.' parsed_keychains+=("${BASH_REMATCH[1]}") done <<< "$1" (( ${#parsed_keychains[@]} > 0 )) || fail 'The existing keychain configuration is empty.' } cleanup() { local status=$? failed=false trap - EXIT INT TERM if [[ $keychain_changed == true ]]; then security default-keychain -d user -s "$original_default" >/dev/null 2>&1 || failed=true security list-keychains -d user -s "${original_search[@]}" >/dev/null 2>&1 || failed=true if [[ -e $keychain ]]; then security delete-keychain "$keychain" >/dev/null 2>&1 || failed=true; fi fi rm -rf "$work" || failed=true if [[ $failed == true ]]; then printf '%s\n' 'Could not restore or remove the temporary keychain.' >&2; [[ $status != 0 ]] || status=1; fi exit "$status" } trap cleanup EXIT trap 'exit 130' INT trap 'exit 143' TERM [[ -s build/unsigned/app.tar.gz && ! -L build/unsigned/app.tar.gz ]] || fail 'Missing or unsafe unsigned app archive.' mkdir "$work/extracted" Scripts/parcel-dev.sh release-extract build/unsigned/app.tar.gz "$work/extracted" "$PRODUCT_NAME.app" Scripts/bundle-preflight.sh "$work/extracted/$PRODUCT_NAME.app" configuration=$(security default-keychain -d user) || fail 'Could not read the default keychain.' parse_keychains "$configuration" (( ${#parsed_keychains[@]} == 1 )) || fail 'Expected one default keychain.' original_default=${parsed_keychains[0]} configuration=$(security list-keychains -d user) || fail 'Could not read the keychain search list.' parse_keychains "$configuration" original_search=("${parsed_keychains[@]}") keychain_password=$(openssl rand -base64 32) keychain_changed=true # Only this random, short-lived password uses argv; persistent secrets use pipes. security create-keychain -p "$keychain_password" "$keychain" >/dev/null 2>&1 || fail 'Could not create the temporary keychain.' security set-keychain-settings -lut 7200 "$keychain" >/dev/null 2>&1 || fail 'Could not configure the temporary keychain.' security unlock-keychain -p "$keychain_password" "$keychain" >/dev/null 2>&1 || fail 'Could not unlock the temporary keychain.' security default-keychain -d user -s "$keychain" >/dev/null 2>&1 || fail 'Could not select the temporary keychain.' security list-keychains -d user -s "$keychain" >/dev/null 2>&1 || fail 'Could not isolate the keychain search list.' printf '%s\0%s' "$p12_password" "$p12" | Scripts/parcel-dev.sh release-certificate-json | swift Scripts/release-keychain.swift import >/dev/null 2>&1 || fail 'Could not import the Developer ID certificate.' unset p12 p12_password security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$keychain_password" "$keychain" >/dev/null 2>&1 || fail 'Could not grant signing access to the temporary keychain.' unset keychain_password identities=$(security find-identity -v -p codesigning "$keychain") grep -Fq -- "\"$identity\"" <<< "$identities" || fail 'Imported keychain has no matching valid identity.' printf '%s' "$asc" > "$work/AuthKey.p8" unset asc set_value SIGN_IDENTITY "$identity" set_value NOTARY_KEY "$work/AuthKey.p8" set_value NOTARY_KEY_ID "$key_id" set_value NOTARY_ISSUER "$issuer" set_value SIGNING_APP "$work/extracted/$PRODUCT_NAME.app" printf '%s' "$seed" | Scripts/sign-release.sh unset seed check_artifacts