Repository navigation
ci: 👷 Require evidence and book updates in pull requests - #234
Merged
Merged
Conversation
Reviews kept finding PRs without a way to see that the change works, and the rule of #131 that code changes update the book pages had no check. The PR_Evidence workflow fails while "How I checked it works" is empty, or while a change to code under src/ has no images, so the contributor sees it right after opening the PR instead of after a review. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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
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
Makes every PR show how the change was checked, and makes code changes update the book pages that describe them (#131, "Keeping the book in step").
PR_Evidenceworkflow: fails while "How I checked it works" is empty, or while a PR with new or changed code undersrc/has no images. Editing the description runs it again. PRs opened before the PR template (2026-11-14) are skipped, and theno images neededlabel lets a change with nothing to show (for example a docstring only) passpull_request_target, so first-time contributors see the result without waiting for workflow approval. It only reads the PR description and the list of changed files, never checks out or runs the PR's code, and has read-only permissionsHOWTOCONTRIBUTE.mdStep 4, and thepr-reviewskill and checklist, say the sameHow I checked it works
pull_request_targetreads the workflow frommain, so this PR itself isn't checked; the first run is on the next PR event after mergingImages
Not needed: no code under
src/changes.Book
🤖 Generated with Claude Code