ci: Prevent CI workflows on bot commits and README updates #455
Conversation
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
justinpolygon
requested review from
morningvera,
mmoghaddam385 and
jbonzo
as code owners
|
As a prime example, it has even stopped this PR. You might wonder, why are we only seeing this now? Well, we have seen it in the past, it's just that code coverage badge used to take a while so we'd normally pass the tests before it did anything. I guess they must have sped up the coverage run, or our tests are taking longer, and now we're seeing it all the time. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit addresses an issue where the automated commits made by the code coverage bot, specifically updates to README.md, trigger the lint and test GitHub Actions workflows to stop. This behaviour leads to race conditions and unnecessary CI runs on commits that don't affect the codebase. A good example here this PR #453 where the badge gets updated and stops the tests from completing. It is also blocking this PR #454.
Changes implemented:
[skip ci]to the commit message in thecode-coverageworkflow to prevent triggering CI workflows on bot-generated commits.lint.yaml,codeql.yml, andtest.yamlworkflows to Includedpaths-ignoreforREADME.md, so changes to this file alone won't trigger the workflows.By combining these methods, we can stop that pesky CI workflow and only run when relevant code changes occur.