Skip to content

Commit

Permalink
Merge pull request #158 from buildkite/pie-1179-document-prefixsuffix…
Browse files Browse the repository at this point in the history
…-functionality

Document execution prefix/suffix environment variables
  • Loading branch information
swebb authored Oct 5, 2022
2 parents 32407ca + 108ec9c commit 6610bb3
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,15 @@ Buildkite::TestCollector.annotate("User logged in successfully")

This is particularly useful for tests that generate a lot of span data such as system/feature tests.

## 🏷️ Tagging duplicate test executions with a prefix/suffix

For builds that execute the same test multiple times - such as when running the same test suite against multiple versions of ruby/rails - it's possible to tag each test execution with a prefix/suffix. This prefix/suffix is displayed for each execution on the test show page to differentiate the build environment. The prefix/suffix is specified using these environment variables:

```
BUILDKITE_ANALYTICS_EXECUTION_NAME_PREFIX
BUILDKITE_ANALYTICS_EXECUTION_NAME_SUFFIX
```

## 🔍 Debugging

To enable debugging output, set the `BUILDKITE_ANALYTICS_DEBUG_ENABLED` environment variable to `true`.
Expand Down

0 comments on commit 6610bb3

Please sign in to comment.