Open
Conversation
Add an update-readme job that regenerates README.md and pushes a fix commit to same-repo PRs when it's out of date. The lint-test job is skipped when a fix is pushed, since the new commit re-triggers CI. Fork PRs are unaffected — the job is skipped and the existing diff check in lint-test still catches stale READMEs. This primarily targets Renovate PRs, which often update dependencies without updating the README. The job is generic enough to be useful for other PRs as well, though. Signed-off-by: Tom Hayward <thayward@infoblox.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add an update-readme job that regenerates README.md and pushes a fix commit to same-repo PRs when it's out of date. The lint-test job is skipped when a fix is pushed, since the new commit re-triggers CI.
Fork PRs are unaffected — the job is skipped and the existing diff check in lint-test still catches stale READMEs.
This primarily targets Renovate PRs, which often update dependencies without updating the README. The job is generic enough to be useful for other PRs as well, though.