Pub w GitHub Actions
Zadania w GitHub Actions czytają i publikują prywatne pakiety bez żadnego przechowywanego sekretu: każde zadanie wymienia własny token tożsamości na token Pub ważny 15 minut. Jak to działa u każdego dostawcy, opisuje strona Pub w CI.
1. Zaufanie wystawcy
GitHub.com jest już zaufany. W przypadku GitHub Enterprise Server właściciel organizacji dodaje jego wystawcę, https://<your host>/_services/token, jako własnego wystawcę tej organizacji.
2. Powiązanie repozytorium
W Control Room należy otworzyć Organization, potem CI access, Bind a repository, i wybrać GitHub Actions. Formularz wymaga podania:
- Repository: owner/name, jak w adresie URL repozytorium: acme/app.
- Owner: użytkownik lub organizacja, do której należy repozytorium: acme.
- Workflow file, optional: workflow, który może publikować: .github/workflows/release.yml. Workflow wielokrotnego użytku z innego repozytorium zapisuje się jako owner/repo/.github/workflows/<file>.yml.
- Environment name, optional: środowisko GitHub, w którym działa zadanie, np. release. Jego reguły ochrony warunkują wtedy każdą wymianę.
- Ref pattern, optional: ref gałęzi, tagu lub pull requestu: refs/tags/v* albo refs/heads/main.
Następnie należy przydzielić powiązaniu pakiety jego przyciskiem Packages: do odczytu albo do odczytu i publikacji.
3. Wymiana w zadaniu
Identyfikator organizacji, z tego samego ekranu „Organization”, należy umieścić w DARTASTIC_ORG_ID. To zadanie publikuje; dla zadania, które tylko czyta, należy usunąć dart pub publish i przydzielić powiązaniu tylko odczyt.
# .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- Workflow potrzebuje permissions: id-token: write, inaczej GitHub nie daje zadaniu żadnego tokenu do wymiany.
- Należy zażądać tokenu z audience https://dartastic.io: robi to wywołanie ACTIONS_ID_TOKEN_REQUEST_URL we fragmencie kodu.
- ::add-mask:: chroni token Pub przed trafieniem do logu zadania.
Gdy wymiana zostaje odrzucona
Log zadania pokazuje najpierw przyczynę, na przykład TRUSTED PUBLISHER REF MISMATCH. Każdą przyczynę i sposób postępowania opisuje strona Pub w CI. Przewodnik dostawcy GitHub Actions po jego tokenach jest w jego dokumentacji.