File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed
Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -120,6 +120,18 @@ made to our documentation website every time we make a commit in a pull request.
120120The service has a configuration file ` .readthedocs.yaml ` , with a list of options
121121to 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
You can’t perform that action at this time.
0 commit comments