Skip to content

docs(flaky-tests): publish Test Collections page + changelog entry#137

Draft
samgutentag wants to merge 2 commits into
mainfrom
sam-gutentag/test-collections-docs
Draft

docs(flaky-tests): publish Test Collections page + changelog entry#137
samgutentag wants to merge 2 commits into
mainfrom
sam-gutentag/test-collections-docs

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

Publishes the Test Collections docs (the page existed but was hidden: true) and adds the matching changelog entry.

What changed

  • flaky-tests/get-started/test-collections.mdx — removed hidden: true, fixed duplicated Tests/Uploads bullets, added a Collection-level quarantining section linking to the quarantining docs.
  • docs.json — added the page to the Get Started nav; added the changelog entry to the changelog nav.
  • changelog/2026-04-22-flaky-tests-test-collections.mdx — new entry, wired into changelog/index.mdx and flaky-tests/changelog.mdx (new April 2026 section).

Live status

GA — verified from trunk2 code: no showTestCollections flag exists, the collections routes/nav helper are unguarded, and the e2e CRUD tests run with no flag-enable step. Shipped v154 (2026-04-16), fully featured (incl. collection quarantining) by v160 (2026-04-22). Changelog dated 2026-04-22 accordingly.

Source

  • Linear: TRUNK-18209 (changelog), TRUNK-18012 / TRUNK-18048 / TRUNK-18066 / TRUNK-18067 (eng)
  • trunk2: #3583 (CRUD core), #3598 (UI/service polish), #3660 (collection quarantining), #3678 (CRUD UI fixes)

Engineering authors

Notes for review

  • Changelog date (2026-04-22) — change if you'd prefer it read as a current-week announcement.
  • Links use the page's existing relative style; root-relative conversion is tracked separately in TRUNK-18408.

🤖 Generated with Claude Code

Unhide and wire the existing Test Collections page into the Get Started
nav, fix duplicated tab bullets, and add a collection-level quarantining
section linking to the quarantining docs.

Add a Test Collections changelog entry (2026-04-22, GA via v160) wired
into all four surfaces: the .mdx file, docs.json changelog nav,
changelog/index.mdx, and the Flaky Tests changelog index.

Source: TRUNK-18209; trunk2 #3583/#3598/#3660/#3678.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@samgutentag samgutentag added the changelog PR touches the changelog (auto-generated drafts, hosting, formatting, indexing). label May 29, 2026
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trunk 🟢 Ready View Preview May 29, 2026, 4:31 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…n-short-id

verify-docs-against-code: the analytics-cli uploader arg is
`--test-collection-short-id` (env TRUNK_TEST_COLLECTION_SHORT_ID),
derived from the clap field; there is no `--collection` flag.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@samgutentag
Copy link
Copy Markdown
Member Author

Code verification (2026-05-29): 3 confirmed / 1 contradicted / 0 ambiguous / 1 unverifiable

Claim Verdict Source
Upload to a collection via trunk flakytests upload --collection <short-id> contradicted analytics-cli/cli/src/upload_command.rs:74
Collection short ID appears in URL /flaky-tests/collections/<short-id> confirmed trunk2/.../flaky-tests-navigation.ts:53
Create/edit/delete is org-admin-only; members can view confirmed delete-collection-section.tsx:164
Tests/Uploads tabs disabled until results are uploaded confirmed collection-navigation.tsx:160
Each collection has quarantine settings overriding repo-level unverifiable (shipped + documented; backend not traced this pass)

Action taken: the CLI flag was --collection in the docs but no such flag exists. The analytics-cli uploader declares the arg as #[arg(long)] on field test_collection_short_id, so clap derives --test-collection-short-id (env TRUNK_TEST_COLLECTION_SHORT_ID). I corrected both the page and the changelog to --test-collection-short-id in the latest commit. @dfrankland please confirm the exact trunk flakytests upload wrapper surface (the verified flag is on the trunk-analytics-cli uploader; the trunk launcher should pass it through but I did not trace the wrapper).


Source #1 — CLI upload flag (contradicted, corrected)

File: trunk-io/analytics-cli/cli/src/upload_command.rs#L74-L81

    #[arg(
        long,
        env = constants::TRUNK_TEST_COLLECTION_SHORT_ID_ENV,
        help = "Optional test collection short ID to attach to the uploaded bundle for collection-aware ingestion.",
        required = false,
        num_args = 1
    )]
    pub test_collection_short_id: Option<String>,

Reasoning: clap's #[arg(long)] with no explicit long = "..." derives the flag name from the field, kebab-cased: test_collection_short_id becomes --test-collection-short-id. There is no alias/visible_alias, so --collection resolves to nothing. The env var (constants/src/lib.rs:30) is TRUNK_TEST_COLLECTION_SHORT_ID. Corrected value: --test-collection-short-id.

Source #3 — admin-only management (confirmed)

File: delete-collection-section.tsx#L164-L200

  const { data: adminData } = useQuery(GetCurrentUserIsAdminForDeleteCollectionDocument, ...);
  const isAdmin = adminData?.currentUserIsAdmin ?? false;
  ...
      disabled={!isAdmin}
  ...
      Only organization admins can delete collections

Reasoning: the destructive action is gated on currentUserIsAdmin; non-admins get a disabled control with an explicit admin-only message. This confirms the admin-only management claim and the view-for-all framing.

Source #5 — tabs disabled until upload (confirmed)

File: collection-navigation.tsx#L160-L162

        label="Tests"
        disabled={testsTab === "DISABLED"}
        isActive={isActive("tests")}

Reasoning: the Tests (and Uploads) tabs render with disabled tied to a CollectionTabStatus of DISABLED, and the empty state links to "Configure uploads" on the Overview tab. Tabs are inactive until the collection has data.

@samgutentag samgutentag added the needs eng review verify-docs-against-code: at least one claim contradicts source. label May 29, 2026
@samgutentag samgutentag added the ready to merge Verify docs PR: customers can use this. Ready to publish. label May 29, 2026
@samgutentag
Copy link
Copy Markdown
Member Author

samgutentag commented May 29, 2026

Verification status (2026-05-29): pending

Eng merged but the feature owner says it is not ready for customers. Hold off.

  • Flag state: read directly from LaunchDarkly where applicable. No feature-availability flag exists for Test Collections (showTestCollections search returns 0 results in trunk2; collection routes and nav helper are unguarded; e2e flags.json has no collection flag). The only LaunchDarkly reference in the stack (#3660) gates quarantine dual-write and webhook propagation, which is backend plumbing, not feature visibility, and exposes no app.launchdarkly.com/projects/ URL to read.
  • Eng PRs: trunk-io/trunk2#3583 (merged via stack of #3545-#3550), #3598, #3660, #3678. All merged 2026-04-16 to 04-22, merge commits intact on main. Recursively inspected the stacked children per the stacked-merges edge case: no flag definitions in any child.
  • Flag: none gating feature availability.
  • Signals: code is unguarded and shipped a month-plus ago, BUT @dfrankland (the author of all source PRs) commented on this PR 2026-05-29 "Not ready to go live yet." That authoritative eng signal overrides the code-unguarded read. Downgraded from the prior live verdict to pending.

Next: keep in draft. Confirm with @dfrankland what remains before GA, then re-run. Note the chained verify-docs-against-code check already flagged a contradicted CLI flag (--collection corrected to --test-collection-short-id); needs eng review stays until @dfrankland confirms the trunk flakytests upload wrapper surface.

@dfrankland
Copy link
Copy Markdown
Member

Not ready to go live yet :)

@samgutentag samgutentag added pending Verify docs PR: eng merged but flag off in prod. Hold off. and removed ready to merge Verify docs PR: customers can use this. Ready to publish. labels May 29, 2026
Copy link
Copy Markdown
Member Author

Verification status (May 31, 2026): pending

The code is unguarded, but the eng author has explicitly asked to hold off on going live.

  • Flag state: not consulted
  • Eng PR: none (code already merged)
  • Flag: none
  • Signals: @dfrankland commented on May 29 "Not ready to go live yet" — holding at pending until cleared by author

Next action: wait for @dfrankland to give the go-ahead, then merge.


Generated by Claude Code

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

Labels

changelog PR touches the changelog (auto-generated drafts, hosting, formatting, indexing). needs eng review verify-docs-against-code: at least one claim contradicts source. pending Verify docs PR: eng merged but flag off in prod. Hold off.

Development

Successfully merging this pull request may close these issues.

2 participants