Skip to content

Commit 20dc597

Browse files
authored
Document Continuous Benchmarking in Maintainers Guides (#3631)
1 parent ef71a9d commit 20dc597

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/maintenance.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,18 @@ made to our documentation website every time we make a commit in a pull request.
120120
The service has a configuration file `.readthedocs.yaml`, with a list of options
121121
to change the default behaviour at <https://docs.readthedocs.io/en/stable/config-file/index.html>.
122122

123+
## Continuous Benchmarking
124+
125+
We use the [CodSpeed](https://codspeed.io) service to continuously track PyGMT's
126+
performance. The `pytest-codspeed` plugin collects benchmark data and uploads it to the
127+
CodSpeed server, where results are available at <https://codspeed.io/GenericMappingTools/pygmt>.
128+
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.
123135

124136
## Dependencies Policy
125137

0 commit comments

Comments
 (0)