docs: move the API workspace to the satellite patch releases - #132
Merged
Merged
Conversation
understudy-phpstan 0.5.2, understudy-phpunit 0.4.1, understudy-psalm 0.8.3, understudy-testo 0.3.3. The freshness gate in docs.yml (composer outdated --direct --strict) has been red on master since 2026-09-07 because the committed lock stayed behind; the pins (^0.5/^0.4/^0.8/^0.3) already cover the patches, so only the lock and the regenerated snapshots move.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Moves
docs/.api-workspace/composer.lockto the satellite patch releases and regenerates the API snapshots:The constraints in the workspace
composer.json(^0.5/^0.4/^0.8/^0.3) already cover the patches, so only the lock and the reflected docs move — the API surface itself is unchanged (version footers, source-link SHAs, git-describe strings only).Why
The freshness gate in
docs.yml(composer outdated --direct --strict, step "Refuse a workspace that documents a satellite behind its release") has been red on master since 2026-09-07 (runs 34112818983, 34835731626). It also made Dependabot PR #131 carry a failingBuildcheck unrelated to its diff.Per the workspace rule in
AGENTS.md: the lock is committed and moves with every satellite release — bump,composer update,make docs-api, commit all three.Verification
composer outdated --direct --strict --ignore phpdocumentor/reflection-docblockin the workspace: "All your direct dependencies are up to date", exit 0.make docs-api: generated 34 API class pages, functions.md (4), exceptions.md, rules.md (5 identifiers).