Skip to content

docs: document test-collection-id as required, and note variant is rarely needed - #150

Merged
TylerJang27 merged 4 commits into
mainfrom
tyler/require-test-collection-id
Sep 30, 2026
Merged

TylerJang27 merged 4 commits into
mainfrom
tyler/require-test-collection-id

Conversation

@TylerJang27

@TylerJang27 TylerJang27 commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Uploads to Flaky Tests are routed by test collection, but the README's example workflow left out the collection ID, and neither parameter table listed it.

  • README: the example now sets test-collection-id:, and the Required Parameters table lists it.
  • action.yaml: the description changes from "Optional 8 character alphanumeric ID…" to "8 character alphanumeric ID of the test collection to upload to. Required unless your organization is still migrating from legacy repo uploads." The Marketplace listing shows this description. The input stays required: false, since customers still migrating to collections upload without one.
  • variant: the README row and the action.yaml description now say it is not usually necessary, and is only for tracking the same tests run in different environments separately. trunk fmt re-aligned the README's Optional Parameters table to fit the longer row.

No runtime change.

🤖 Generated with Claude Code

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

trunk-staging-io Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Static Badge   Static Badge   Static Badge

View Full Report ↗︎ ⋅ Docs

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@TylerJang27 TylerJang27 changed the title docs: document test-collection-id as a required input docs: document test-collection-id as required, and note variant is rarely needed Sep 30, 2026
@trunk-io

trunk-io Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Static Badge   Static Badge   Static Badge

View Full Report ↗︎ ⋅ Docs

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@TylerJang27

Copy link
Copy Markdown
Collaborator Author

/trunk merge --direct

Comment thread action.yaml Outdated
required: false
test-collection-id:
description: Optional 8 character alphanumeric ID for a test collection.
description: 8 character alphanumeric ID of the test collection to upload to. Required for new setups.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"Required for new setups" I think we might want to wordsmith this better

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@TylerJang27
TylerJang27 merged commit 2accee9 into main Sep 30, 2026
8 checks passed
@TylerJang27
TylerJang27 deleted the tyler/require-test-collection-id branch September 30, 2026 18:03
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.

2 participants