Skip to content

docs(tests): clarify report key behavior#541

Closed
ischolten wants to merge 1 commit into
mainfrom
codex/clarify-tests-run-key-help
Closed

docs(tests): clarify report key behavior#541
ischolten wants to merge 1 commit into
mainfrom
codex/clarify-tests-run-key-help

Conversation

@ischolten

@ischolten ischolten commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • clarify that --key identifies report uploads, not split timings
  • explain when to use a distinct value for multiple report uploads from one job

Verification

  • gofmt -d pkg/cmd/tests/run.go
  • go test ./...

Note

Low Risk
Documentation-only change to a CLI flag description; no runtime behavior changes.

Overview
Updates the --key flag help text on depot tests run so it matches how the command actually behaves.

The description now calls it a report invocation key (still defaulting to GITHUB_ACTION or a default), tells users to set a distinct value when one job uploads reports more than once, and explicitly states that --key does not affect split timings (those use --split-key).

Reviewed by Cursor Bugbot for commit 6d8a0a5. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved: Cursor Bugbot and Cursor Security Agent both completed successfully with no findings requiring human review. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

@ischolten ischolten closed this Jul 14, 2026
@ischolten
ischolten deleted the codex/clarify-tests-run-key-help branch July 14, 2026 00:13
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.

1 participant