在CI中使用Pub
您的CI无需存储任何密钥即可读取和发布您的私有package。每个作业使用其CI提供商自己的身份令牌证明自己属于哪个仓库,并获得一个有效期15分钟的Pub令牌。
工作原理
- 绑定仓库。在Control Room中打开Organization,找到CI access。Bind a repository用于指定哪个仓库的CI运行可代表您的组织,并可选择仅限某个工作流、环境或分支。绑定由所有者或管理员执行。
- 为它授予package。每个绑定都是您组织中的一个CI成员。通过它的Packages按钮,可以为它授予package的读取权限或读取和发布权限,与授予团队成员完全相同。未授予任何权限时,它可读取全局package和您组织的引擎(如果有),且不能发布任何内容。移除绑定即会移除该成员及其获得的所有权限。
- 在作业中交换令牌。作业为受众
https://dartastic.io请求身份令牌,并将其连同您的组织ID发送到令牌交换端点。组织ID就在同一个“Organization”页面上。 - 使用Pub令牌。
dart pub token add将其交给dart pub get和dart pub publish使用(flutter pub同理)。
您的CI提供商
| 提供商 | 绑定之前 |
|---|---|
| GitHub Actions | GitHub.com已默认受信任。对于GitHub Enterprise Server,需由所有者将其颁发者https://<your host>/_services/token添加为本组织自己的颁发者。 |
| GitLab CI/CD | GitLab.com已默认受信任。对于自管理的GitLab,需由所有者将其地址https://<your host>添加为本组织自己的颁发者。 |
| Bitbucket Pipelines | 每个Bitbucket工作区都有自己的颁发者,因此需由所有者先添加:在“CI access”的“This organization's own CI issuers”下,选择Bitbucket Pipelines并输入工作区的URL名称。 |
| CircleCI | 每个CircleCI组织都有自己的颁发者,因此需由所有者先添加:在“CI access”的“This organization's own CI issuers”下,选择CircleCI并输入组织ID。 |
令牌交换
作业将其身份令牌作为Bearer令牌发送,并将您的组织ID作为请求正文:
shell
curl -sS --fail-with-body -X POST https://api.dartastic.io/v1/ci/exchange \
-H "Authorization: Bearer $CI_TOKEN" -H "Content-Type: application/json" \
-d '{"orgId":"<your organization id>"}'响应包含Pub令牌及其可执行的操作:
json
{
"token": "dtc_…", // the Pub token, valid for 15 minutes
"keyId": "…",
"organizationId": "<your organization id>",
"packages": ["my_package"], // what it may publish ([] when it only reads)
"packageAccess": { … }, // what it may read
"expiresAt": 1767225600 // seconds since 1970
}- 每个身份令牌只能交换一次。请在每个作业开始时交换一次,并在作业的后续步骤中保留该Pub令牌。
- 该Pub令牌可读取全局package、您组织的引擎(如果有),以及授予该CI成员的每个package,并可发布授予了发布权限的package。除此之外,它不能执行任何操作。
- 每次交换都会记录在您组织的审计日志(Audit Log)中,包括仓库、运行和提交。
交换被拒绝时
拒绝信息会首先给出原因,因此作业日志会原样显示:
json
{"error": {"code": "permission-denied",
"message": "TRUSTED PUBLISHER REF MISMATCH: …",
"details": {"reason": "TRUSTED PUBLISHER REF MISMATCH"}}}| 原因 | 处理方法 |
|---|---|
CI EXCHANGE ORG MISSING | 请求未指定组织。请将{"orgId": "<your organization id>"}作为请求体发送。 |
CI OIDC TOKEN MISSING | 请求未携带CI令牌。请以Authorization: Bearer <token>发送。 |
CI OIDC AUDIENCE INVALID | 该令牌是为其他受众请求的。请按代码片段的方式为https://dartastic.io请求令牌。 |
CI OIDC ISSUER NOT TRUSTED | 该令牌的颁发者不受此组织信任。对于Bitbucket、CircleCI、GitHub Enterprise Server或自管理的GitLab,需由所有者先添加颁发者。 |
CI OIDC EXPIRED | 令牌在交换前已过期。请在作业请求到令牌后立即交换。 |
CI OIDC TOKEN REPLAYED | 此令牌已被交换过。每个令牌只能交换一次:每个作业交换一次。 |
TRUSTED PUBLISHER NOT BOUND | 此组织没有任何绑定指向该作业的仓库。请在“CI access”中绑定,并检查工作流中的orgId。 |
TRUSTED PUBLISHER REPOSITORY MISMATCH | 绑定指向的是另一个仓库或项目。UUID和ID必须是该作业自己的。 |
TRUSTED PUBLISHER WORKFLOW MISMATCH | 作业运行所用的工作流或流水线文件不是绑定所允许的。 |
TRUSTED PUBLISHER ENVIRONMENT MISMATCH | 作业未在绑定指定的环境中运行(在CircleCI上则是未使用其上下文)。 |
TRUSTED PUBLISHER REF MISMATCH | 作业运行所在的分支或标签与绑定的ref模式不匹配。 |
TRUSTED PUBLISHER REPOSITORY ID MISMATCH | 该仓库已被删除并以相同名称重新创建。请移除绑定,然后绑定新仓库。 |
TRUSTED PUBLISHER AMBIGUOUS | 有多个绑定与该作业匹配。请收窄这些绑定(工作流、环境或ref),使恰好只有一个匹配。 |
CI OIDC CLAIM MISSING | 令牌缺少提供方总会发送的某个声明。请检查该令牌是否为提供方自己的CI令牌,并按代码片段的方式请求。 |
CI OIDC SSH RERUN | 这是一个通过SSH重新运行的CircleCI作业。请不使用SSH重新运行。 |
CI EXCHANGE RATE LIMITED | 此仓库或组织在短时间内的交换次数过多。每个作业只交换一次,然后稍候重试。 |
BOX STATE PUSH FAILED | Pub仓库未收到新令牌。请重新运行作业。 |