Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
  • Loading branch information
niceking and mbelton-buildkite authored Jul 6, 2023
1 parent 3472fe0 commit 3a274d4
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions pages/test_analytics/ci_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@ If you run test collectors inside [containers](/docs/test-analytics/ci-environme
If you're not using a test collector, see [Importing JSON](/docs/test-analytics/importing-json) and [Importing JUnit XML](/docs/test-analytics/importing-junit-xml) to learn how to provide run environment data.

## Recommended environment variables
If you're manually providing Buildkite Test Analytics environment variables, we'd strongly recommend setting the following variables:

| Field name | Description | Features unlocked |
|------------------------|-----------------------------------------------|---------------------------------------------------|
| `run_env[key]` | the UUID for the build | required field, group batches of data by this key |
| `run_env[branch]` | the branch or reference for this build | filter data by branch |
| `run_env[url]` | the URL for the build on your CI provider | handy link back to your CI build |
| `run_env[commit_sha]` | the commit hash for the head of the branch | enable automatic flaky test detection |
| `run_env[message]` | the commit message for the head of the branch | easily identify your runs |
{: class="responsive-table"}

If you're manually providing environment variables, we strongly recommend setting the following variables:

- `run_env[key]`: A required variable that sends the UUID for the build, letting you group batches of data by the key.
- `run_env[branch]`: Sends the branch or reference for this build, enabling you to filter data by branch.
- `run_env[url]`: Provides the URL for the build on your CI provider, giving you a handy link back to the CI build.
- `run_env[commit_sha]`: Sends the commit hash for the head of the branch, enabling automatic flaky test detection in your builds.
- `run_env[message]`: Forwards the commit message for the head of the branch, helping you identify different runs more easily.

## Containers and test collectors

Expand Down

0 comments on commit 3a274d4

Please sign in to comment.