Pub vanuit GitHub Actions
Jobs in GitHub Actions lezen en publiceren uw privépackages zonder opgeslagen secret: elke job wisselt zijn eigen identiteitstoken in voor een Pub-token dat 15 minuten geldig is. Hoe het bij elke provider werkt, staat op Pub vanuit CI.
1. Vertrouw de issuer
GitHub.com wordt al vertrouwd. Voor GitHub Enterprise Server voegt een eigenaar de issuer ervan, https://<your host>/_services/token, toe als eigen issuer van deze organisatie.
2. Koppel de repository
Open in de Control Room Organization, daarna CI access en Bind a repository, en kies GitHub Actions. Het formulier vraagt om:
- Repository: owner/name, zoals in de URL van de repository: acme/app.
- Owner: de gebruiker of organisatie die eigenaar is: acme.
- Workflow file, optional: de workflow die mag publiceren: .github/workflows/release.yml. Een herbruikbare workflow in een andere repository schrijft u als owner/repo/.github/workflows/<file>.yml.
- Environment name, optional: een GitHub-environment waarin de job draait, zoals release. De beschermingsregels daarvan bewaken dan elke uitwisseling.
- Ref pattern, optional: een ref van een branch, tag of pull request: refs/tags/v* of refs/heads/main.
Geef de koppeling daarna haar packages met de knop Packages: lezen, of lezen en publiceren.
3. Wissel in de job
Zet de id van uw organisatie, van hetzelfde scherm “Organization”, in DARTASTIC_ORG_ID. Deze job publiceert; voor een job die alleen leest, laat u dart pub publish weg en geeft u de koppeling alleen leestoegang.
# .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- De workflow heeft permissions: id-token: write nodig, anders geeft GitHub de job geen token om uit te wisselen.
- Vraag het token aan met audience https://dartastic.io: de aanroep van ACTIONS_ID_TOKEN_REQUEST_URL in het fragment doet dat.
- ::add-mask:: houdt het Pub-token uit de log van de job.
Als het wordt geweigerd
De log van de job toont eerst de reden, zoals TRUSTED PUBLISHER REF MISMATCH. Elke reden en wat u eraan doet, staat op Pub vanuit CI. De eigen handleiding van GitHub Actions over de tokens staat in de documentatie.