在GitHub Actions中使用Pub
GitHub Actions作业无需存储任何密钥即可读取和发布您的私有package:每个作业用自己的身份令牌交换一个有效期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按钮为它授予package:读取,或读取和发布。
[TODO:“Bind a repository”对话框,已选择GitHub Actions并填入acme/app的屏幕截图]
3. 在作业中交换令牌
将您的组织ID(在同一个“Organization”页面上)填入DARTASTIC_ORG_ID。此作业会发布package;若作业只需读取,请删除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关于其令牌的官方指南见其文档。