ci: fail pull requests when generated README is stale - #1871
Closed
yuyua9 wants to merge 1 commit into
Closed
Conversation
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
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.
Summary
This adds a pull-request-time check for generated documentation artifacts.
The PR workflow now runs
npm run buildand fails when the generatedREADME.mddiffers from the committed file.Why
The repository's push workflow currently regenerates documentation and can create
[ci skip] Automatic file changes/fixcommits after changes land onmaster. Checking the generated output during the pull request keeps the PR self-contained and makes stale generated files visible before merge.Tests
npm install --no-audit --no-fundnpm run lintnpm run buildgit diff --exit-code -- README.mdReal behavior proof
README.mdnow fails its CI job instead of relying on a post-merge auto-fix commit.Anduin2017/HowToCookatorigin/mastercommitc694a5c457d45e6e012ae6cd9a7724aab86e320b.npm run buildfollowed bygit diff --exit-code -- README.md.git diff --checkalso exits 0.