README.md in buildkite-test_collector-1.2.5 vs README.md in buildkite-test_collector-1.3.0
- old
+ new
@@ -68,9 +68,28 @@
git checkout -b add-buildkite-test-analytics
git commit -am "Add Buildkite Test Analytics"
git push origin add-buildkite-test-analytics
```
+## 🗨️ Annotations
+
+This gem allows adding custom annotations to the span data sent to Buildkite using the [.annotate](https://github.com/buildkite/test-collector-ruby/blob/d9fe11341e4aa470e766febee38124b644572360/lib/buildkite/test_collector.rb#L64) method. For example:
+
+```ruby
+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`.
## 🔜 Roadmap