Document Continuous Benchmarking in Maintainers Guides #3631
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
added
documentation
seisman
changed the title
weiji14
reviewed
Nov 19, 2024
There was a problem hiding this comment.
Thanks @seisman. Do we also want to mention how the https://github.com/apps/codspeed-hq bot works? Or how a run/benchmark label needs to be put on a PR to get the benchmarks to run?
This is a one-off thing, and it's well documented at https://docs.codspeed.io/, so I guess we don't have to document it.
Added in f508d4e. |
weiji14
approved these changes
Nov 19, 2024
seisman
added
final review call
yvonnefroehlich
approved these changes
Nov 19, 2024
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
We have been using the CodSpeed service for about 1 year since #2908. The service seems stable and can help us track the performance.
This PR documents "Continuous Benchmarking" in the "Maintainers Guides", then we should be able to close #2910.
Preview: https://pygmt-dev--3631.org.readthedocs.build/en/3631/maintenance.html