從CI使用Pub
您的CI不需儲存任何密鑰,就能讀取及發布您的私有套件。每個作業以其CI供應商自己的身分識別權杖證明自己是哪個存放庫,並取得有效期15分鐘的Pub權杖。
運作方式
- 繫結存放庫。在Control Room中開啟Organization,找到CI access。Bind a repository可指定哪個存放庫的CI執行能代表您的組織行事,並可選擇只限於某個工作流程、環境或分支。由擁有者或管理員進行繫結。
- 授予套件權限。每個繫結都是您組織的一個CI成員。透過它的Packages按鈕,可授予它讀取套件,或讀取並發布套件的權限,與授予團隊成員的方式完全相同。未授予任何權限時,它可讀取全域套件和您組織的引擎(若有的話),且不能發布任何套件。移除繫結會一併移除該成員及其所有權限。
- 在作業中交換。作業為受眾
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,並輸入工作區的網址名稱。 |
| CircleCI | 每個CircleCI組織都有自己的簽發者,因此請由擁有者先新增:在「CI access」的「This organization's own CI issuers」下,選擇CircleCI,並輸入組織ID。 |
權杖交換
作業將其身分識別權杖作為持有人權杖傳送,並以您的組織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權杖可讀取全域套件、您組織的引擎(若有的話),以及授予該CI成員的所有套件,並可發布獲授予發布權限的套件。除此之外不能做任何事。
- 每次交換都會記錄在組織的「Audit Log」中,包含存放庫、執行和commit。
交換遭拒時
拒絕訊息會先列出原因,讓作業的記錄原樣顯示:
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上則是未使用其context)。 |
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 | 登錄服務沒有收到新的權杖。請重試此作業。 |