Skip to content

Document Continuous Benchmarking in Maintainers Guides - #3631

Merged
seisman merged 3 commits into
mainfrom
doc/benchmark
Nov 19, 2024
Merged

Document Continuous Benchmarking in Maintainers Guides#3631
seisman merged 3 commits into
mainfrom
doc/benchmark

Conversation

@seisman

@seismanseisman commented Nov 19, 2024

Copy link
Copy Markdown
Member

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

@seismanseisman added documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. labels Nov 19, 2024
@seismanseisman added this to the 0.14.0 milestone Nov 19, 2024
@seisman
seisman requested a review from weiji14November 19, 2024 06:49
@seismanseisman changed the title Document Continuous Benchmarking used in PyGMTDocument Continuous Benchmarking in Maintainers GuidesNov 19, 2024

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Comment threaddoc/maintenance.md Outdated
@seisman

Copy link
Copy Markdown
MemberAuthor

Do we also want to mention how the https://github.com/apps/codspeed-hq bot works?

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.

Or how a run/benchmark label needs to be put on a PR to get the benchmarks to run?

Added in f508d4e.

@seismanseisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Nov 19, 2024
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Nov 19, 2024
@seisman
seisman merged commit 20dc597 into mainNov 19, 2024
@seisman
seisman deleted the doc/benchmark branch November 19, 2024 15:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Benchmark performance of PyGMT functions

3 participants

@seisman@weiji14@yvonnefroehlich