Skip to content

Audit and fix org slug terminology#522

Open
samgutentag wants to merge 1 commit intomainfrom
samgutentag/org-slug-audit
Open

Audit and fix org slug terminology#522
samgutentag wants to merge 1 commit intomainfrom
samgutentag/org-slug-audit

Conversation

@samgutentag
Copy link
Member

Summary

Audited all org slug terminology across the docs for consistency. Searched every .md file for: TRUNK_ORG_SLUG, TRUNK_ORG_URL_SLUG, org-url-slug, org-slug, and "organization slug".

What was fixed

flaky-tests/get-started/ci-providers/github-actions.md line 38 — The setup instructions told users to store GitHub secrets as TRUNK_ORG_URL_SLUG and TRUNK_API_TOKEN, but the code examples on the same page reference secrets.TRUNK_ORG_SLUG and secrets.TRUNK_TOKEN. A user following the instructions step by step would save the secret under one name and reference it under another. Changed to TRUNK_ORG_SLUG and TRUNK_TOKEN to match the code examples and every other CI provider doc.

What was confirmed correct

  • CLI flag references: All use --org-url-slug consistently (matches the actual binary flag).
  • Env var TRUNK_ORG_URL_SLUG: Used correctly in RSpec plugin examples where the CLI reads from environment (e.g., TRUNK_ORG_URL_SLUG=$TRUNK_ORG_SLUG). These pass an arbitrary CI secret name into the real env var the CLI reads — correct pattern.
  • GitHub Action input: All use org-slug: (matches action.yaml).
  • Placeholders in code examples: <TRUNK_ORG_SLUG> used consistently as a human-readable template token in non-Action CLI examples.
  • CI secret names: All other CI provider pages (GitLab, CircleCI, Jenkins, Buildkite, Travis CI, Bitbucket, Semaphore, Azure DevOps, Drone CI, Bamboo) consistently tell users to store the secret as TRUNK_ORG_SLUG — no issues found.
  • Prose references: "organization slug" is used consistently in prose across framework and setup docs.
  • RSpec README: Correctly uses TRUNK_ORG_URL_SLUG=<TRUNK_ORG_URL_SLUG> (setting the real env var directly with a placeholder value).

Open questions

None — the only issue found was the GitHub Actions page mismatch, which is now fixed.

🤖 Generated with Claude Code

The GitHub Actions CI provider page told users to store secrets as
TRUNK_ORG_URL_SLUG and TRUNK_API_TOKEN, but the code examples on the
same page reference secrets.TRUNK_ORG_SLUG and secrets.TRUNK_TOKEN.
A user following the instructions step by step would save the secret
under one name and reference it under another.

Changed to TRUNK_ORG_SLUG and TRUNK_TOKEN to match the code examples
on the page and every other CI provider doc.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@trunk-staging-io
Copy link

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

@samgutentag samgutentag marked this pull request as ready for review March 23, 2026 20:22
@claude
Copy link
Contributor

claude bot commented Mar 23, 2026

Claude finished @samgutentag's task in 54s —— View job


PR Review

  • Read changed file and diff
  • Verify the fix is correct
  • Check for remaining inconsistencies in the file

The Fix (line 38) ✅

The change is correct. The setup instructions now tell users to store secrets as TRUNK_ORG_SLUG and TRUNK_TOKEN, which matches the code examples in the main upload section (lines 77, 99, 121).


Remaining Inconsistencies ⚠️

The quarantining section was not updated and still references secrets.TRUNK_API_TOKEN in multiple places, which now conflicts with the setup instructions on line 38 that tell users to store the secret as TRUNK_TOKEN.

Lines 176 and 200 (Enable quarantining > GitHub Actions Workflow tab):

token: ${{ secrets.TRUNK_API_TOKEN }}

Lines 287 and 328 (Getting Direct Links to Job Logs section):

token: ${{ secrets.TRUNK_API_TOKEN }}

All four should be ${{ secrets.TRUNK_TOKEN }} for consistency.

Additionally, lines 217 and 229 (CLI direct tab) reference $TRUNK_API_TOKEN as a bare env var. These are less critical since they're showing CLI usage pattern, but are worth making consistent.

Fix remaining TRUNK_API_TOKEN references →


The core fix is correct and needed, but the quarantining examples introduce a new inconsistency that would confuse users following the quarantining setup path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant