Add docs for benchmarks, only run on PRs

DataDog · Nov 18, 2022 · f489505 · f489505
1 parent b7a1e4c
commit f489505
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.gitlab/benchmarks.yml b/.gitlab/benchmarks.yml
@@ -7,6 +7,9 @@ benchmark:
   stage: benchmarks
   image: $BASE_CI_IMAGE
   timeout: 1h
+  only:
+    refs:
+      - branches
   interruptible: true
   tags: ["runner:apm-k8s-tweaked-metal"]
   script:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -58,3 +58,7 @@ git update-index --no-assume-unchanged go.*
 ### Milestones
 
 The maintainers of this repository assign milestones to pull requests to classify them. `Triage` indicates that it is yet to be decided which version the change will go into. Pull requests that are ready get the upcoming release version assigned.
+
+### Benchmarks
+
+Some benchmarks will run on any new PR commits, the results will be commented into the PR on completion. To see the list of benchmarks or to add additional benchmarks run go to `.gitlab/scripts/run-benchmarks.sh`.