Pub aus GitHub Actions
Jobs in GitHub Actions lesen und veröffentlichen Ihre privaten Packages ohne gespeichertes Secret: Jeder Job tauscht sein eigenes Identitätstoken gegen ein Pub-Token, das 15 Minuten gilt. Wie das bei jedem Anbieter funktioniert, steht unter Pub aus der CI.
1. Dem Aussteller vertrauen
GitHub.com ist bereits vertrauenswürdig. Für GitHub Enterprise Server fügt ein Inhaber dessen Aussteller https://<your host>/_services/token als eigenen Aussteller dieser Organisation hinzu.
2. Das Repository binden
Öffnen Sie im Control Room Organization, dann CI access, Bind a repository, und wählen Sie GitHub Actions. Das Formular fragt nach:
- Repository: owner/name, wie in der URL des Repositorys: acme/app.
- Owner: der Nutzer oder die Organisation, der es gehört: acme.
- Workflow file, optional: der Workflow, der veröffentlichen darf: .github/workflows/release.yml. Ein wiederverwendbarer Workflow in einem anderen Repository ist owner/repo/.github/workflows/<file>.yml.
- Environment name, optional: ein GitHub-Environment, in dem der Job läuft, etwa release. Dessen Schutzregeln gelten dann für jeden Austausch.
- Ref pattern, optional: ein Branch, ein Tag oder eine Pull-Request-Ref: refs/tags/v* oder refs/heads/main.
Erteilen Sie der Bindung dann über ihre Schaltfläche Packages ihre Packages: Lesen oder Lesen und Veröffentlichen.
3. Im Job austauschen
Tragen Sie die ID Ihrer Organisation aus derselben Ansicht „Organization“ in DARTASTIC_ORG_ID ein. Dieser Job veröffentlicht; für einen, der nur liest, lassen Sie dart pub publish weg und erteilen der Bindung nur Lesezugriff.
# .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- Der Workflow braucht permissions: id-token: write, sonst gibt GitHub dem Job kein Token zum Austauschen.
- Fordern Sie das Token mit der Audience https://dartastic.io an: Der Aufruf von ACTIONS_ID_TOKEN_REQUEST_URL im Snippet erledigt das.
- ::add-mask:: hält das Pub-Token aus dem Log des Jobs heraus.
Wenn er abgelehnt wird
Das Log des Jobs zeigt zuerst den Grund, etwa TRUSTED PUBLISHER REF MISMATCH. Alle Gründe und was zu tun ist, stehen unter Pub aus der CI. Die eigene Anleitung von GitHub Actions zu seinen Tokens finden Sie in der Dokumentation des Anbieters.