Merge pull request #157 from buildkite/pie-985-add-annotation-instruc…

…tions-to-the-ruby Document the annotation method
buildkite · Oct 3, 2022 · 32407ca · 32407ca
2 parents 291a08f + 8a02e9d
commit 32407ca
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,16 @@ 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.
+
 ## 🔍 Debugging
 
 To enable debugging output, set the `BUILDKITE_ANALYTICS_DEBUG_ENABLED` environment variable to `true`.