Skip to content

Audit and fix org slug terminology#522

Merged
trunk-staging-io[bot] merged 7 commits intomainfrom
samgutentag/org-slug-audit
May 7, 2026
Merged

Audit and fix org slug terminology#522
trunk-staging-io[bot] merged 7 commits intomainfrom
samgutentag/org-slug-audit

Conversation

@samgutentag
Copy link
Copy Markdown
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
Copy Markdown

trunk-staging-io Bot commented Mar 23, 2026

😎 Merged successfully - details.

@samgutentag samgutentag marked this pull request as ready for review March 23, 2026 20:22
@claude
Copy link
Copy Markdown
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.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 27, 2026

Claude finished @samgutentag's task in 1m 3s —— View job


PR Review

  • Read changed file and diff
  • Check for remaining inconsistencies
  • Post review feedback

Blocking Issue: Unresolved Merge Conflict ❌

The file contains unresolved git conflict markers at line 38 of flaky-tests/get-started/ci-providers/github-actions.md:

<<<<<<< samgutentag/org-slug-audit
Store the Trunk slug and API token... named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.
=======
Store the Trunk slug and API token... named `TRUNK_ORG_URL_SLUG` and `TRUNK_TOKEN` respectively.
>>>>>>> main

The merge conflict was committed to the branch without being resolved. The <<<<<<, =======, and >>>>>>> markers will render verbatim in the documentation. This must be fixed before merging.

The correct resolution is to keep the PR branch version (TRUNK_ORG_SLUG) and remove the conflict markers and the main version.

Fix merge conflict →


Other Observations

Duplicate intro paragraph (pre-existing, not introduced by this PR): Lines 7 and 11 are nearly identical:

  • Line 7: "Before you start these steps, see the [Test Frameworks] docs for instructions on producing Trunk-compatible reports for your test runner."
  • Line 11: "Before you start on these steps, see the [Test Frameworks] docs for instructions on producing a Trunk-compatible output for your test framework."

One of these should be removed.

Quarantining/token references: The rest of the file consistently uses secrets.TRUNK_TOKEN throughout the quarantining and direct links sections — no remaining TRUNK_API_TOKEN issues found (the previous review's concerns appear to have been resolved).


The core intent of this PR (fixing the TRUNK_ORG_URL_SLUGTRUNK_ORG_SLUG mismatch) is correct, but the file cannot be merged in its current state due to the unresolved conflict markers.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 5, 2026

Claude finished @samgutentag's task in 1m 2s —— View job


PR Review

  • Read CLAUDE.md for repo guidelines (none found)
  • Read the changed file
  • Check git diff for current state
  • Verify merge conflict resolution
  • Post final review

Blocking Issue: Unresolved Merge Conflict ❌

The file still contains unresolved git conflict markers at lines 38–42 of flaky-tests/get-started/ci-providers/github-actions.md:

<<<<<<< samgutentag/org-slug-audit
Store the Trunk slug and API token ... named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.
=======
Store the Trunk slug and API token ... named `TRUNK_ORG_URL_SLUG` and `TRUNK_TOKEN` respectively.
>>>>>>> main

The <<<<<<, =======, and >>>>>>> markers are committed to the branch and will render verbatim in the documentation. This PR cannot be merged in its current state.

The correct resolution is to keep the PR branch version (TRUNK_ORG_SLUG) and remove all three conflict markers plus the TRUNK_ORG_URL_SLUG line.

Fix merge conflict →


Pre-existing Issue (not introduced by this PR)

Duplicate intro paragraph at lines 7 and 11:

  • Line 7: "Before you start these steps, see the [Test Frameworks] docs for instructions on producing Trunk-compatible reports for your test runner."
  • Line 11: "Before you start on these steps, see the [Test Frameworks] docs for instructions on producing a Trunk-compatible output for your test framework."

These two sentences are nearly identical and serve the same purpose. One should be removed. This is pre-existing and not a blocker for this PR, but worth cleaning up.


What Was Confirmed Correct ✅

  • The intended fix (TRUNK_ORG_URL_SLUGTRUNK_ORG_SLUG in the setup instruction) is the right change — it aligns the secret name with every code example in the file (lines 81, 103, 125, 138).
  • All quarantining section examples consistently use secrets.TRUNK_TOKEN — no remaining TRUNK_API_TOKEN issues.
  • All --org-url-slug CLI flag references are correct (CLI binary flag, not a secret name).
  • RSpec plugin example correctly maps TRUNK_ORG_URL_SLUG=${{ secrets.TRUNK_ORG_SLUG }} (assigning the env var the CLI reads from the stored secret).

@samgutentag
Copy link
Copy Markdown
Member Author

Triage status (2026-05-05): up to date with main. Pure bug fix (org slug terminology mismatch on GitHub Actions page). Safe to merge after a quick review.

@samgutentag
Copy link
Copy Markdown
Member Author

samgutentag commented May 6, 2026

Verification status (2026-05-07, re-verified): live

Verified: customers can use this. The change itself is a pure docs terminology fix and is safe to publish.

  • Eng PR: none (pure docs change)
  • Linear ticket: none referenced in PR body
  • Flag: none
  • Signals: PR is a docs-only terminology fix (org slug consistency on the GitHub Actions setup page). No eng work to gate on.

Merge readiness (this is the part that needs attention):

  • GitHub reports MERGEABLE, but the file on origin still contains literal <<<<<<<, =======, >>>>>>> markers at lines 38-42 of flaky-tests/get-started/ci-providers/github-actions.md. The previous merge commit 64bd4df committed the conflict markers verbatim. If trunk-merge fires right now, those markers will publish to docs.trunk.io.
  • The local fix commit b06d58d ("fix: resolve unresolved merge conflict markers from main") cleans them up — line 38 now reads correctly as a single line: "Store the Trunk slug and API token obtained in the previous step in your repo as GitHub secrets named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively." That commit has not been pushed yet.
  • Pre-existing nit (not introduced by this PR, flagged by Claude reviewer three times): duplicate intro paragraphs at lines 7 and 11 of the same file. Worth a follow-up cleanup but not a blocker.

Suggested next action: push b06d58d to origin so the file content matches what reviewers expect, then merge. Optionally fold the duplicate-intro fix into the same push or open a separate follow-up.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 6, 2026

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


PR Review

  • Read changed file and check current state
  • Verify merge conflict resolution
  • Check for typos, grammar, formatting issues
  • Post final review

Blocking Issue: Unresolved Merge Conflict ❌

The file flaky-tests/get-started/ci-providers/github-actions.md still contains unresolved git conflict markers at lines 38–42:

<<<<<<< samgutentag/org-slug-audit
Store the Trunk slug and API token ... named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.
=======
Store the Trunk slug and API token ... named `TRUNK_ORG_URL_SLUG` and `TRUNK_TOKEN` respectively.
>>>>>>> main

The <<<<<<<, =======, and >>>>>>> markers are committed to the branch and will render verbatim in the published documentation. This PR cannot be merged in its current state.

The correct resolution is to keep the PR-branch version (TRUNK_ORG_SLUG) and delete the marker lines and the main-side line. The result should be a single line:

Store the Trunk slug and API token obtained in the previous step in your repo as GitHub secrets named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.

Fix merge conflict →


Pre-existing Nit (not introduced by this PR)

Duplicate intro paragraph at lines 7 and 11 — these two sentences are nearly identical and serve the same purpose:

  • Line 7: "Before you start these steps, see the [Test Frameworks] docs for instructions on producing Trunk-compatible reports for your test runner."
  • Line 11: "Before you start on these steps, see the [Test Frameworks] docs for instructions on producing a Trunk-compatible output for your test framework."

One should be removed. Not a blocker for this PR — flagging for visibility.


What Was Confirmed Correct ✅

  • The intended fix (TRUNK_ORG_URL_SLUGTRUNK_ORG_SLUG in the setup instruction) is the right change — it aligns the secret name with every code example in the file.
  • All other terminology (CLI flags --org-url-slug, env var TRUNK_ORG_URL_SLUG in RSpec examples, GitHub Action input org-slug, prose "organization slug") is consistent across the docs as the PR description claims.
  • All quarantining-section secrets correctly use secrets.TRUNK_TOKEN — no remaining TRUNK_API_TOKEN issues.

Summary: Blocking — the conflict markers must be removed before merging. Once that's done, the underlying change is correct and ready.
Branch

Comment on lines +38 to +42
<<<<<<< samgutentag/org-slug-audit
Store the Trunk slug and API token obtained in the previous step in your repo as [GitHub secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.
=======
Store the Trunk slug and API token obtained in the previous step in your repo as [GitHub secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) named `TRUNK_ORG_URL_SLUG` and `TRUNK_TOKEN` respectively.
>>>>>>> main
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: unresolved git merge conflict markers committed to the branch. These will render verbatim in the published docs. Keep the PR-branch version (TRUNK_ORG_SLUG) and remove the markers plus the main-side line.

Suggested change
<<<<<<< samgutentag/org-slug-audit
Store the Trunk slug and API token obtained in the previous step in your repo as [GitHub secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.
=======
Store the Trunk slug and API token obtained in the previous step in your repo as [GitHub secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) named `TRUNK_ORG_URL_SLUG` and `TRUNK_TOKEN` respectively.
>>>>>>> main
Store the Trunk slug and API token obtained in the previous step in your repo as [GitHub secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) named `TRUNK_ORG_SLUG` and `TRUNK_TOKEN` respectively.

samgutentag and others added 2 commits May 6, 2026 21:18
Conflict markers from the prior merge were committed to the branch
without resolution, which would render verbatim on the published page.
Keeps the PR-side line (TRUNK_ORG_SLUG) per the original audit fix.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Two near-identical "Before you start these steps, see Test Frameworks"
sentences existed at lines 7 and 11. Combined into one sentence after
the integration paragraph so the flow is header to context to prereq.
Pre-existing nit flagged by Claude reviewer three times on this PR.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 7, 2026

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


PR Review

  • Read changed file and check current state
  • Verify merge conflict resolution
  • Check token reference consistency
  • Check for typos, grammar, formatting issues
  • Post final review

Status: Ready to Merge ✅

Both previously-blocking issues have been resolved on this branch:

  1. Merge conflict markers (commit b06d58d) — The <<<<<<<, =======, >>>>>>> markers at lines 38–42 are gone. Line 36 now reads cleanly:

    Store the Trunk slug and API token obtained in the previous step in your repo as GitHub secrets named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.

  2. Duplicate intro paragraph (commit a5fe0be) — The two near-identical sentences at the top of the file have been merged into a single line (line 9):

    Before you start these steps, see the Test Frameworks docs for instructions on producing Trunk-compatible reports for your test framework.


Net Diff vs. origin/main

- duplicate intro paragraph (removed)
- TRUNK_ORG_URL_SLUG → TRUNK_ORG_SLUG (line 36)

Two real changes, both correct.


What Was Verified ✅

  • No conflict markers anywhere in the file (grep is clean).
  • Secret-name consistency: every secrets.TRUNK_TOKEN and secrets.TRUNK_ORG_SLUG reference in the file matches the names users are told to store on line 36. No stray TRUNK_API_TOKEN references.
  • CLI-flag references (--org-url-slug) and the GitHub Action input (org-slug:) are unchanged — correct, since those are real binary/action interfaces, not secret names.
  • RSpec example (line 132) correctly maps TRUNK_ORG_URL_SLUG=${{ secrets.TRUNK_ORG_SLUG }} — assigns the CLI's expected env var from the user's stored secret. This is the right pattern.
  • Grammar/formatting: the merged intro paragraph reads naturally; no other typos found in the diff.

Summary: No blocking issues. The core terminology fix is correct, the merge conflict is resolved, and the duplicate-intro nit flagged in prior reviews has been cleaned up in the same PR. Safe to merge.
Branch

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-approved: Claude code review passed.

@trunk-staging-io trunk-staging-io Bot merged commit 58b9848 into main May 7, 2026
7 checks passed
@trunk-staging-io trunk-staging-io Bot deleted the samgutentag/org-slug-audit branch May 7, 2026 07:32
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