Mac App Release
BlackBar、RepoBar、CodexBar、Trimmyなど、Sparkleで更新されるmacOSアプリに使用します。
ルール
- アプリのリポジトリから作業します。
.mac-release.envを読み込みます。これはリポジトリが所有するリリースマニフェストです。- このスキルの
scripts/mac-releaseを使用して、共有のリリース/アプリキャスト/検証作業を行います。 - アプリ固有のビルド/パッケージ化/署名動作は、マニフェストで駆動されない限り、リポジトリのスクリプトに保持します。
- 秘密鍵の内容は絶対に出力しないでください。
- Keychain Sparkle署名を優先します。
SPARKLE_PRIVATE_KEY_FILEは明示的なオーバーライドのみです。
コマンド
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release status
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release notes [version] [output.md]
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release changelog-html <version> [CHANGELOG.md]
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release make-appcast <zip> [feed-url]
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release verify-appcast [version]
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release check-assets [tag]
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release release
/Users/steipete/Projects/agent-scripts/skills/release-mac-app/scripts/mac-release codesign-run [--with-package-secrets] -- <command> [args...]
マニフェスト
各リポジトリは .mac-release.env を所有します。これにはシークレットを含めてはいけません。
必須:
MAC_RELEASE_APP_NAMEMAC_RELEASE_REPOMAC_RELEASE_BUNDLE_IDMAC_RELEASE_VERSION_FILEMAC_RELEASE_APPCASTMAC_RELEASE_FEED_URLMAC_RELEASE_DOWNLOAD_URL_PREFIXMAC_RELEASE_APP_ZIPMAC_RELEASE_INFO_PLISTまたはMAC_RELEASE_SUPUBLIC_ED_KEYのいずれかMAC_RELEASE_PACKAGE_CMD
一般的なオプション:
MAC_RELEASE_PRECHECKMAC_RELEASE_SOURCE_FILES(スペース区切りのアプリヘルパーファイル。アーティファクト名を展開する前にソースとして読み込む)MAC_RELEASE_DSYM_ZIPMAC_RELEASE_REQUIRE_DSYM=0(アプリのみのリリースの場合)MAC_RELEASE_ARTIFACT_PREFIXMAC_RELEASE_TAG_SIGNEDMAC_RELEASE_TAG_FORCEMAC_RELEASE_RELEASE_BRANCHMAC_RELEASE_SPARKLE_ACCOUNTMAC_RELEASE_SPARKLE_CHANNELMAC_RELEASE_GENERATE_APPCAST_ARGSMAC_RELEASE_RUN_SPARKLE_UPDATE_TESTMAC_RELEASE_SIGNING_KEY_FILE(ローカルフォールバックパスのみ。ファイルがない場合はKeychainが使用される)MAC_RELEASE_EXTRA_ASSET_PATTERNSMAC_RELEASE_EXTRA_ASSET_WAIT_SECONDSMAC_RELEASE_EXTRA_ASSET_WAIT_INTERVALMAC_RELEASE_OP_ITEM+MAC_RELEASE_OP_FIELDS(必要なパッケージングシークレット用。リリースヘルパーは、1つの永続的なtmuxセッション内でopを介して既知のアイテムを一度読み取り、パッケージコマンド用に要求されたフィールドをエクスポートします。)MAC_RELEASE_OP_ACCOUNTのデフォルトはmy.1password.com。MAC_RELEASE_OP_VAULT、MAC_RELEASE_OP_TMUX_SESSION、MAC_RELEASE_OP_WAIT_SECONDSはオプションです。ボールトがない場合、その1回のop読み取りのためにサービスアカウントトークン環境変数は設定解除され、個人のデスクトップアカウントがそれを処理します。MAC_RELEASE_CODESIGN_IDENTITY+MAC_RELEASE_CODESIGN_OP_ITEM+MAC_RELEASE_CODESIGN_KEYCHAIN_MANAGED=1により、非対話型のDeveloper ID署名が有効になります。キーチェーンは交換可能で、リリース自動化専用であり、デフォルトのキーチェーンとは別で、対話型使用と共有せず、正確に1つの署名秘密鍵を含む必要があります。ヘルパーはそのキーのパーティションACLをapple-tool:,apple:,codesign:に所有し、永続的に正規化する場合があります。事前チェック後、同じtmuxクレデンシャルパスがkeychain_pathとkeychain_passwordを読み取り、ユーザーごとのリリースロックを取得し、プライベートファイルディスクリプタを介してCLI PTYにパスワードを供給し、既存のキーチェーンを隠さずにキーチェーンを先頭に追加し、Developer ID Applicationのカナリアを検証し、一時的なcodesign --keychainラッパーを介してパッケージ署名をスコープし、一時的な状態を復元し、再ロックしてロックを解放します。MAC_RELEASE_CODESIGN_OP_ACCOUNT、MAC_RELEASE_CODESIGN_OP_VAULT、MAC_RELEASE_CODESIGN_OP_USE_SERVICE_ACCOUNT、MAC_RELEASE_CODESIGN_OP_PATH_FIELD、およびMAC_RELEASE_CODESIGN_OP_PASSWORD_FIELDは、codesignクレデンシャルアイテムのデフォルトをオーバーライドします。アカウント、ボールト、およびサービスアカウントモードは、それ以外の場合はプライマリアイテム設定を継承します。個人のデスクトップアカウントアイテムの場合は、ボールトを空に、サービスアカウントモードを0に設定します。代わりにMAC_RELEASE_CODESIGN_KEYCHAIN+MAC_RELEASE_CODESIGN_KEYCHAIN_PASSWORDを直接指定することもできます。MAC_RELEASE_RUN_LOGIN_SHELL=1は、コマンドフックをbash -lcに戻します。デフォルトのフックはenv -u BASH_ENV bash -cを使用するため、シェル起動ファイルはエクスポートされたリリースシークレットを上書きできません。
1Passwordのルール:
- すでにエクスポートされた環境変数を優先します。すべての
MAC_RELEASE_OP_FIELDSが存在する場合、op呼び出しは行いません。 - フィールドが不足している場合、設定されたパッケージアイテムとcodesignアイテムを、リリース全体で1つのtmuxコマンドで読み取ります。
- 明示的なボールトまたは
MAC_RELEASE_OP_USE_SERVICE_ACCOUNT=1がある場合にのみサービスアカウントモードを使用します。 - 新しいシェルで
op読み取りを再試行しないでください。明示的なユーザー指示があった場合にのみ、同じtmuxセッションから再実行します。 - 準備ができていないDeveloper IDキーチェーンでリリースがアプリのパッケージ化に達することを決して許可しないでください。リリース中にSecurityAgentのパスワードウィンドウを表示させず、最初に署名カナリアを失敗させてください。
- アプリ以外のリリーススクリプトの場合は、キーチェーン設定をリポジトリにコピーする代わりに
codesign-runを使用してください。.mac-release.envまたは明示的なMAC_RELEASE_CODESIGN_*環境設定を介してcodesignマニフェストフィールドを提供します。デフォルトではcodesignクレデンシャルのみをロードします。ラップされたリリーススクリプトが同じ1Passwordパスで設定されたパッケージ/公証フィールドも必要とする場合は、--with-package-secretsを渡します。バインドされた署名カナリアを実行し、管理キーチェーンラッパーを介してcodesignをスコープし、復元/再ロックしてから戻ります。 - リリースシークレットをロードする前に、シェルのxtraceおよびverboseモードを無効にします。キーチェーン/検索リストの変更の前にクリーンアップを設定し、専用キーチェーンの元のロックポリシーとユーザー検索リストを復元し、パッケージ化後に再ロックします。
完了時
- アプリキャストエントリにURL、長さ、Sparkle署名がある。
- ダウンロードされたenclosureがSparkleで検証される。
- 抽出されたアプリが
codesign、spctl、およびstapler validateに合格する。 - GitHubリリースにアプリzip、設定されている場合はdSYM zip、およびアプリ固有の追加アセットがある。
- リリースノートがCHANGELOGのセクションと一致する。
- 検証済みリリース後、アプリリポジトリのCHANGELOGを次のパッチの
Unreleasedにバンプする。