Repository navigation
ci: check the README's PHP blocks against the package - #13
Merged
Merged
Conversation
…s#8) A reader who copies a PHP block out of the README gets code that parses and calls what this package has, and a block that stops doing so fails CI before it ships. The job calls the shared check pinned by full commit SHA; a doc change runs it, since this workflow has no paths-ignore. Packagist publishes by the tag alone, so there is no publish job to wait on it. The architecture diagram's fence now names what it is (`text`), which is what the sweep reads a fence for. Refs macula-codebase-checks#8
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.
Purpose (usability): a reader who copies a PHP block out of the README gets code that parses and calls what this package has, and a block that stops doing so fails CI before it ships (macula-io/macula-codebase-checks#8).
ci.yml: adocsjob callingmacula-io/macula-ci-images/.github/workflows/doc-snippets-php.ymlpinned by full commit SHA (d25a36c). The workflow has nopaths-ignore, so a doc-only change runs it. Packagist publishes by the tag alone, so there is no publish job here to wait on it.text), which is what the sweep reads a fence for.Locally the shared check reports 0 failures in 3 blocks (
php -lplus PHPStan at level 2 against the package's own autoloader). This repository's CI runs on main and on pull requests, so this draft PR is what runs the new job on a branch.Refs macula-io/macula-codebase-checks#8
🤖 Generated with Claude Code