Skip to content

Commit f508d4e

Browse files
committed
Add instructions to trigger benchmarking in PR
1 parent 615b7ec commit f508d4e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/maintenance.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,12 @@ We use the [CodSpeed](https://codspeed.io) service to continuously track PyGMT's
126126
performance. The `pytest-codspeed` plugin collects benchmark data and uploads it to the
127127
CodSpeed server, where results are available at <https://codspeed.io/GenericMappingTools/pygmt>.
128128

129-
Benchmarking is handled through the `benchmarks.yml` GitHub Actions workflow. To include
130-
a new test in the benchmark suite, apply the `@pytest.mark.benchmark` decorator to the
131-
test function.
129+
Benchmarking is handled through the `benchmarks.yml` GitHub Actions workflow. It's
130+
automatically executed when a pull request is merged into the main branch. To trigger
131+
benchmarking in a pull request, add the `run/benchmark` label to the pull request.
132+
133+
To include a new test in the benchmark suite, apply the `@pytest.mark.benchmark`
134+
decorator to a test function.
132135

133136
## Dependencies Policy
134137

0 commit comments

Comments
 (0)