-
Notifications
You must be signed in to change notification settings - Fork 102
Sets heavy GitHub CI workflows to not trigger on text documentation-only changes. #2417
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
Sets heavy GitHub CI workflows to not trigger on text documentation-only changes. #2417
Conversation
Specifically, sets azure-ci-dispatcher.yml and therock-ci.yml to not trigger when the change consists entirely of .txt, .md, or .rtf files.
Most notably, any changes in the 'docs' folder, or the 'docs' folder in any project, are now excluded.
8a4520b to
d3762e4
Compare
This workflow should now correctly skip docs-only changes, even on pushes.
…hanges_commitable
This should eliminate unnecessary testing, and speed up documentation development.
Specifically, fixes the old incorrect paths like '**.txt' to be of the style '**/*.txt'.
Specifically, changes them from the incorrect '**.txt' style to '**/*.txt'.
geomin12
left a comment
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.
looks fine, although this will break PRs for therock-ci.yml, as TheRock CI is required to run
please add here for TheRock:
| SKIPPABLE_PATH_PATTERNS = [ |
… configure script.
|
Is it safe to assume changes to *.txt are non-functional (and don't require testing?). For example, maybe changes to a CMakeLists.txt? |
Excellent point, I didn't consider CMakeLists.txt. I'll remove ignoring .txt files in favour of just listing docs-specific .txt files we know to ignore. |
Specifically, instead of excluding all .txt files (which would catch things like CMakeLists.txt), now only specific .txt files are excluded.
geomin12
left a comment
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.
lgtm for TheRock CI
…hanges_commitable
This is because using both paths and paths-ignore at the same time is not allowed.
Motivation
Currently, full installation and unit test runs are conducted even for changes of only documentation files; this greatly slows down docs development work.
Technical Details
This change modifies two of the largest workflows, azure-ci-dispatcher.yml and therock-ci.yml, as well as many rocprofiler workflows, to not trigger on PRs or pushes that consist entirely of documentation changes.
JIRA ID
AIROCDOC-78, AIROCDOC-424, AIROCDOC-425
Test Plan
Test Result
The test_branch_bin_feeder PR caused the modified workflows to still trigger, as expected. The test_branch_text_feeder PR caused the modified workflows to be skipped, as desired.