Keep docsgen
from updating protected branches
#43
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.
Changes introduced with this PR
This PR adds a check to the
docsgen
reusable workflow which skips the step where it updates the branch if the branch is protected (likemain
), because attempting the update will result in an error which will cause the workflow (and the rest of the CI) to fail.We're not supposed to need updates to protected branches, as the updates are supposed to have been applied to PRs before they are merged, so, under normal circumstances, this change should have no impact. (And, if an update is actually required, it should be detected and applied to the next PR to come along, anyway.)
However, under unusual circumstances (such as when a PR is merged too quickly for the bot to respond, or when the bot is producing an unstable result (arcalot/arcaflow-plugin-fio#39)) this change will prevent the
main
branch CI from failing.By contributing to this repository, I agree to the contribution guidelines.