CI: Run benchmarks if PR is labeled with "run/benchmark" #2958
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,8 +12,8 @@ on: | |
| paths: | ||
| - 'pygmt/**/*.py' | ||
| - '.github/workflows/benchmarks.yml' | ||
| # Run in PRs but only if the PR has the 'run/benchmark' label | ||
| pull_request: | ||
| # `workflow_dispatch` allows CodSpeed to trigger backtest | ||
| # performance analysis in order to generate initial data. | ||
| workflow_dispatch: | ||
|
|
@@ -28,7 +28,7 @@ concurrency: | |
| jobs: | ||
| benchmarks: | ||
| runs-on: ubuntu-22.04 | ||
| if: github.repository == 'GenericMappingTools/pygmt' && contains(github.event.pull_request.labels.*.name, 'run/benchmark') | ||
|
There was a problem hiding this comment. Actually I'm unsure if the workflow will run in the main branch, because it's a push event not a pull_request event. There was a problem hiding this comment. Tried in my own fork. It doesn't work in the main branch. There was a problem hiding this comment. Changed the Now it works in my own fork, see the changes between my fork and the pygmt repository: main...seisman:pygmt:main and the workflow was triggered when pushing in the main branch (https://github.com/seisman/pygmt/actions/workflows/benchmarks.yml). |
||
| defaults: | ||
| run: | ||
| shell: bash -l {0} | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we document in
.github/PULL_REQUEST_TEMPLATE.mdor somewhere for contributors to request that therun/benchmarklabel gets added to PRs that might affect performance? Or just rely on the maintainers to set the label for now?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer to leave the jobs to the maintainers. We probably will document it in the contributors guides when addressing #1113.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, or we can put it in
doc/maintenance.mdsomewhere. Not urgent though, since we aren't running the benchmarks that often.