Don't trigger full build+test CI when only markdown files are edited #2189
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.
Description
Change Summary
Currently, the
build
CI workflow will run even when a push changes only markdown files (e.g., README.md).With these changes, a push that changes only markdown files will not trigger the workflow, thus speeding up the project's CI and saving compute resources 🌱 (see below for quantity).
Example
Here is an example of the behaviour described above: the commit
306833f
changed these files:CHANGELOG.md
and, when pushed, triggered this workflow run, which ran for ~1.5 CPU hours. With the proposed changes, these 1.5 CPU hours would have been saved, clearing the queue for other workflows and speeding up the CI of the project, while also saving resources in general 🌱.Note that this is a single example out of (a minimum of) 81 examples over the last few months; a lower estimate for the accumulated gain is 23 CPU hours, but the actual number could be much higher because we could only look at a subset of the data.
Other such examples include
42213cc
,b99b248
,17b287c
.Context
Hi,
We are a team of researchers from University of Zurich and we are currently working on energy optimizations in GitHub Actions workflows.
Thanks for your time on this.
Kindly let us know (here or in the email below) if you would like to **ignore other file types **or apply the filter to other workflows, or if you have any question whatsoever.
Best regards,
Konstantinos Kitsios
[email protected]
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.