在GitLab CI/CD中使用Pub
GitLab CI/CD作业无需存储任何密钥即可读取和发布您的私有package:每个作业用自己的身份令牌交换一个有效期15分钟的Pub令牌。各提供商的工作原理请参阅在CI中使用Pub。
1. 信任颁发者
GitLab.com已默认受信任。对于自管理的GitLab,需由所有者将其地址https://<your host>添加为本组织自己的颁发者。
2. 绑定仓库
在Control Room中打开Organization,然后依次选择CI access、Bind a repository,再选择GitLab CI/CD。表单要求填写:
- Project path: 项目的完整路径,包括嵌套群组:acme/mobile/app。
- Namespace path, optional: 项目所在的群组:acme/mobile。留空时从项目路径读取。
- Pipeline configuration file, optional: 允许发布的配置:.gitlab-ci.yml。
- Environment name, optional: 作业的environment:,例如production。此后每次交换都受受保护环境的约束。
- Ref pattern, optional: 分支或标签:refs/tags/v*或refs/heads/main。
然后通过该绑定的Packages按钮为它授予package:读取,或读取和发布。
[TODO:“Bind a repository”对话框,已选择GitLab CI/CD并填入acme/mobile/app的屏幕截图]
3. 在作业中交换令牌
将您的组织ID(在同一个“Organization”页面上)填入DARTASTIC_ORG_ID。此作业会发布package;若作业只需读取,请删除dart pub publish,并只为该绑定授予读取权限。
yaml
# .gitlab-ci.yml: publish on a version tag
publish:
image: dart:stable
rules:
- if: $CI_COMMIT_TAG =~ /^v/
environment: production # optional: bind the environment too
id_tokens:
DARTASTIC_ID_TOKEN:
aud: https://dartastic.io
variables:
DARTASTIC_ORG_ID: "<your organization id>"
script:
- apt-get update -qq && apt-get install -y -qq jq
- |
RESP=$(curl -sS --fail-with-body -X POST https://api.dartastic.io/v1/ci/exchange \
-H "Authorization: Bearer $DARTASTIC_ID_TOKEN" -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
- dart pub get
- dart pub publish --force- id_tokens:将令牌放入您指定的变量(此处为DARTASTIC_ID_TOKEN)中提供给作业,并带有aud: https://dartastic.io。
- 在GitLab中将用于发布的标签或分支标记为受保护,这样只有维护者才能启动会进行交换的运行。
[TODO:一个GitLab流水线作业,其交换成功,随后执行dart pub publish的屏幕截图]
被拒绝时
作业日志会首先显示原因,例如TRUSTED PUBLISHER REF MISMATCH。所有原因及处理方法请参阅在CI中使用Pub。GitLab CI/CD关于其令牌的官方指南见其文档。