Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only run asv benchmark when labeled #5893

Merged
merged 3 commits into from
Oct 24, 2021

Conversation

Illviljan
Copy link
Contributor

@Illviljan Illviljan commented Oct 24, 2021

Small fix to #5796. The benchmark was only intended to run when the PR has the label run-benchmark. I split the if condition in multiple lines for better readability thinking it didn't change the function but it did.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2021

Unit Test Results

         6 files           6 suites   53m 8s ⏱️
16 209 tests 14 475 ✔️ 1 734 💤 0
90 450 runs  82 272 ✔️ 8 178 💤 0

Results for commit 3273149.

♻️ This comment has been updated with latest results.

@Illviljan Illviljan added the run-benchmark Run the ASV benchmark workflow label Oct 24, 2021
@Illviljan Illviljan marked this pull request as ready for review October 24, 2021 11:09
@Illviljan Illviljan changed the title Only run benchmark when labeled Only run asv benchmark when labeled Oct 24, 2021
@Illviljan Illviljan merged commit fdabf3b into pydata:main Oct 24, 2021
${{ contains( github.event.pull_request.labels.*.name, 'run-benchmark')
&& github.event_name == 'pull_request'
|| github.event_name == 'workflow_dispatch' }}
if: ${{ contains( github.event.pull_request.labels.*.name, 'run-benchmark') && github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

would it make sense to alternatively allow setting a tag in the commit message? I think it's more likely someone will need to test the performance of specific commits rather than the whole PR. We could even extend ci-trigger to optionally detect labels on PRs...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, I think adding or removing a label is much easier than to remember to add a tag in the commit message. I rarely get it right the first (or second) commit anyway so remembering to add it in several messages is a tough task. The benchmark takes about the same time as the other tests now so I don't think it won't be that much of a bottleneck if it runs a few more times than necessary.

Adding labels is however an admin-only thing so if other contributors want's to run it without asking the maintainers a tag in the commit is good a option.

@Illviljan Illviljan removed the run-benchmark Run the ASV benchmark workflow label Oct 24, 2021
dcherian added a commit to dcherian/xarray that referenced this pull request Oct 29, 2021
* upstream/main:
  Only run asv benchmark when labeled (pydata#5893)
  Add asv benchmark jobs to CI (pydata#5796)
  Remove use of deprecated `kind` argument in `CFTimeIndex` tests (pydata#5723)
  Single matplotlib import (pydata#5794)
  Check jupyter nbs with black in pre-commit (pydata#5891)
snowman2 pushed a commit to snowman2/xarray that referenced this pull request Feb 9, 2022
* Only run benchmark when labeled

* Update benchmarks.yml

* Update benchmarks.yml
@Illviljan Illviljan deleted the asv_benchmark_only_on_label branch August 12, 2022 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants