Skip to content

docs: add ADR 0011 — adopt the Tokens Studio platform token pipeline - #5195

Open
pomfrida wants to merge 3 commits into
mainfrom
docs/adr-0011-tokens-studio-pipeline
Open

docs: add ADR 0011 — adopt the Tokens Studio platform token pipeline#5195
pomfrida wants to merge 3 commits into
mainfrom
docs/adr-0011-tokens-studio-pipeline

Conversation

@pomfrida

@pomfrida pomfrida commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Closes #5197

Summary

Records the architecture decision behind the Tokens Studio pipeline work merged over the last weeks (#5151, #5153, #5155, #5160, #5166, #5175, #5176): the platform is the source of truth for the reworked tokens, updates flow through a release-triggered, OIDC-authenticated CI pipeline that lands platform exports as PRs, and the hourly orphan-branch backup (tokens-studio-backup) compensates for the platform having no undo.

ADR-0008 (TS codegen) documents one slice of this pipeline; this ADR is the overarching decision it builds on, and gives future token ADRs a common anchor.

Part of #5108.

Notes

  • Status is Proposed pending team review — the implementation is merged and running, so the ADR documents rather than proposes the mechanics, but the record itself should be reviewed.
  • Numbered 0011: 0009 is taken by the temporary next-subpaths ADR (docs: add ADR for temporary next subpaths during eds-tokens beta #5194) and 0010 is reserved for the in-flight CSS specifier layout decision.

🤖 Generated with Claude Code

@pomfrida

Copy link
Copy Markdown
Collaborator Author

@claude review

@claude

claude Bot commented Jul 20, 2026

Copy link
Copy Markdown

Claude finished @pomfrida's task in 1m 29s —— View job


Review: ADR 0011 — Tokens Studio platform pipeline

  • Read the ADR
  • Verify cross-references (ADRs, workflows, docs) exist and match
  • Check factual/internal consistency
  • Post review

This is a well-structured, accurate ADR. I cross-checked every substantive claim against the actual sources in the repo and they hold up. No blocking issues — a few minor notes below.

Accuracy check ✅

Verified the "Decision" section against the real implementation:

ADR claim Source Match
repository_dispatch type tokens-release tokens_studio_release.yaml:12
OIDC subject repo:equinor/design-system:ref:refs/heads/main, read-only tokens_studio_backup.yaml:36
Exports referenced by ID not name tokens_studio_release.yaml:82,84 (UUIDs)
Output to src/tokens/{raw,css,dtcg,ts} .studio.json (raw) + workflow --out flags + generate:ts-tokens
Hourly cron, orphan branch, one dir per alias, no-op when unchanged, Slack on failure tokens_studio_backup.yaml:18,49,96–114,117
npm --prefix standalone CLI install outside the workspace tokens_studio_backup.yaml:11–14,77
PRs via built-in GITHUB_TOKEN get no CI create-pull-request@v8 w/ default token

All four Related links resolve (0007, 0008, TOKENS_STUDIO.md, TOKEN_SYSTEM_GUIDE.md), and the structure follows 0000-template.md faithfully.

Minor notes (non-blocking)

  1. Status vs. dependency direction. This ADR is Proposed (line 3), yet ADR-0008 — which the doc describes as building on this decision (line 23, 65) — is already Accepted (0008:3). It reads slightly backwards to have the foundational decision still Proposed while its dependent is Accepted. The PR body explains why (the mechanics are merged and running), so consider adding one line to the Context/Status making that explicit in the ADR itself, since the ADR outlives the PR description.

  2. Numbering gap is invisible in-repo. The directory jumps 0008 → 0011; 0009/0010 don't exist yet. Your PR body explains the reservation, but a reader browsing documentation/adr/ sees an unexplained gap. Optional: a one-line note (e.g. in the Related section) that 0009/0010 are reserved, or leave it — this is a judgement call.

  3. Unsourced precision on line 83. "~2 min to ~20–30 s" — the workflow comment (tokens_studio_backup.yaml:12) only asserts the "~2 min" side ("not worth two minutes every hour"); the 20–30 s warm-run figure isn't recorded anywhere I could verify. Fine to keep, just flagging it's a softer number than the rest.

  4. Nit — line 83 clause "the CLI has no push command". Accurate and consistent with the backup workflow (pull + manual rsync/git), just worth keeping in sync with TOKENS_STUDIO.md so the "pull-only" characterisation lives in one canonical place.

Nice work — the doc is precise and the CI/OIDC/backup rationale is captured at exactly the right altitude for an ADR.
docs/adr-0011-tokens-studio-pipeline

Comment thread documentation/adr/0011-adopt-tokens-studio-platform-pipeline.md Outdated
Comment thread documentation/adr/0011-adopt-tokens-studio-platform-pipeline.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ADR: Tokens Studio platform pipeline adoption

1 participant