cholla-hydro / cholla-hydro/cholla
Skipping Jenkins
- Dominant language
- C++
- Stars
- 74
- Forks
- 41
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 3
Description
We may want to adjust our Jenkins file so that we can disable unnecessary runs.
I'm thinking we should introduce a check that skips the test suite for any commit where the commit-message contains `[skip jenkins]` or `[skip ci]`.[^1] This is actually a common convention:
- all GitHub actions [are automatically skipped](https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/) when `[skip ci]` or `[skip actions]` is present.
- pre-commit.ci [will be skipped](https://pre-commit.ci/#features) when `[skip ci]` or `[skip pre-commit.ci]` is present
- other projects, like [numpy](https://numpy.org/doc/stable/dev/development_workflow.html#commands-to-skip-continuous-integration) and [scipy](https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping) also add logic to do this sort of thing
Alternatively, we could try adding logic to only run the Jenkins logic if we detect changes to a source/build/parameter file. But, I think there's a risk we could mess this up
[^1]: To follow convention, we probably should also look for `[jenkins skip]` or `[ci skip]`.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the repository's Jenkins file and identify where the test suite is invoked. Confirm how commit messages are exposed there, then make the done condition that commits containing the proposed skip markers do not run the test suite while other commits retain the current behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100