Commit the generated symbology gallery - #238
Merged
Merged
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
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.
What
Follow-up to #236: the gallery pages are now committed rather than gitignored, so someone browsing the repository sees every supported QR/barcode rendered by every renderer without running anything.
examples/index.md,examples/codes/*.md(30 pages) andexamples/assets/(~2.3 MB) are checked inExamplesTest::testTheCommittedGalleryIsCurrentruns the generator on every build and fails on any diff against the committed files — a symbology added toDefaults(or a renderer whose output changes) turns the build red until the gallery is regenerated and committed, so a committed page cannot quietly outlive the library it describes.gitignoreentries removed;examples/README.md,gallery.phpdocblock and the CHANGELOG entry updated to matchWhy
A gallery that only exists on a contributor's machine answers the "what does it draw" question for exactly one person. Committing it answers it for everyone — provided it cannot go stale silently, which is what the freshness test is for.
Verification
vendor/bin/phpunit tests/ExamplesTest.php— 5 tests, 283 assertions, OK (including the freshness test, which failed before the files were committed and passes after)composer lint— clean (php-cs-fixer, PHPStan, Rector, kb-lint)