GitHub ActionsからPubを使う
GitHub Actionsのジョブは、保存されたシークレットなしで、プライベートパッケージを読み取り、公開できます。各ジョブは自身のIDトークンを、有効期間15分のPubトークンと交換します。すべてのプロバイダーに共通の仕組みは、CIからPubを使うを参照してください。
1. 発行者を信頼する
GitHub.comは最初から信頼されています。GitHub Enterprise Serverの場合は、オーナーがその発行者https://<your host>/_services/tokenを、この組織独自の発行者として追加します。
2. リポジトリをバインドする
Control Roomで「Organization」、「CI access」、「Bind a repository」の順に開き、GitHub Actionsを選びます。フォームの入力項目:
- Repository: owner/name。リポジトリのURLと同じ形式です:acme/app。
- Owner: リポジトリを所有するユーザーまたは組織:acme。
- Workflow file, optional: 公開を許可するワークフロー:.github/workflows/release.yml。別のリポジトリにある再利用可能なワークフローはowner/repo/.github/workflows/<file>.ymlと書きます。
- Environment name, optional: ジョブを実行するGitHubの環境(例:release)。以後、その環境の保護ルールがすべての交換に適用されます。
- Ref pattern, optional: ブランチ、タグ、プルリクエストのref:refs/tags/v*またはrefs/heads/main。
次に、バインディングの「Packages」ボタンでパッケージを付与します:読み取り、または読み取りと公開。
3. ジョブ内で交換する
同じ「Organization」画面にある組織IDを、DARTASTIC_ORG_IDに設定します。このジョブは公開を行います。読み取りだけのジョブではdart pub publishを削除し、バインディングには読み取りだけを付与してください。
# .github/workflows/publish.yml: publish on a version tag
on:
push:
tags: ['v*']
permissions:
contents: read
id-token: write # lets the job request its OIDC token
jobs:
publish:
runs-on: ubuntu-latest
environment: release # optional: bind the environment too, so its reviewers gate publishing
env:
DARTASTIC_ORG_ID: <your organization id>
steps:
- uses: actions/checkout@v4
- uses: dart-lang/setup-dart@v1
- name: Exchange this job's identity for a 15-minute Pub token
run: |
set -euo pipefail
OIDC=$(curl -sS --fail-with-body \
-H "Authorization: Bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
"$ACTIONS_ID_TOKEN_REQUEST_URL&audience=https://dartastic.io" | jq -er .value)
RESP=$(curl -sS --fail-with-body -X POST https://api.dartastic.io/v1/ci/exchange \
-H "Authorization: Bearer $OIDC" -H "Content-Type: application/json" \
-d "{\"orgId\":\"$DARTASTIC_ORG_ID\"}") || { echo "$RESP" >&2; exit 1; }
export PUB_TOKEN=$(echo "$RESP" | jq -er .token)
dart pub token add https://pub.dartastic.io --env-var PUB_TOKEN
echo "::add-mask::$PUB_TOKEN"
echo "PUB_TOKEN=$PUB_TOKEN" >> "$GITHUB_ENV"
- run: dart pub get
- run: dart pub publish --force- ワークフローにはpermissions: id-token: writeが必要です。これがないと、GitHubはジョブに交換用のトークンを渡しません。
- トークンはオーディエンスhttps://dartastic.ioで要求してください。スニペットのACTIONS_ID_TOKEN_REQUEST_URL呼び出しがそうしています。
- ::add-mask::により、Pubトークンがジョブのログに出力されません。
拒否された場合
ジョブのログには、TRUSTED PUBLISHER REF MISMATCHのように最初に理由が表示されます。すべての理由と対処方法はCIからPubを使うにあります。GitHub Actionsのトークンについては、公式ドキュメントを参照してください。