Disable some CI checks on docs updates #2076
Merged
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.
Change description
Disable the build/test/static code analysis checks on PRs that only touch
docs/**
and**.md
files.Rationale
We often get PRs on documentation, which trigger the entire CI check suite. I propose we disable some of those checks on these occasions, which are computationally intensive and quite irrelevant. They also slow down the review process for PRs that could be merged in a matter of minutes.
A case against this PR:
Sometimes checks will fail on documentation PRs for reasons that are unrelated (e.g. the RPI agents are unavailable, something broke upstream/fprime-tools etc...).
The case could be made that we should know as soon as possible when this happens, and therefore we should not disable those checks. Which I don't disagree with tbh. This is up for debate, totally fine if we don't want to accept this change.