從GitHub Actions使用Pub
GitHub Actions作業不需儲存任何密鑰,就能讀取及發布您的私有套件:每個作業將自己的身分識別權杖交換為有效期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,與存放庫網址中的寫法相同: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: 分支、標籤或pull request的ref:refs/tags/v*或refs/heads/main。
接著透過繫結的Packages按鈕授予其套件權限:讀取,或讀取並發布。
[TODO:「Bind a repository」視窗,已選擇GitHub Actions並填入acme/app的螢幕截圖]
3. 在作業中交換
將您的組織ID(位於同一個「Organization」畫面)放入DARTASTIC_ORG_ID。這個作業會發布套件;若作業只需讀取,請移除dart pub publish,並只授予該繫結讀取權限。
yaml
# .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權杖不出現在作業記錄中。
[TODO:一次GitHub Actions執行,交換步驟成功,接著執行dart pub publish的螢幕截圖]
遭拒時
作業的記錄會先顯示原因,例如TRUSTED PUBLISHER REF MISMATCH。所有原因及處理方式請參閱從CI使用Pub。GitHub Actions本身的權杖指南請參閱其文件。