Skip to content

Move the docs workspace to the released satellites - #188

Merged
rasuvaeff merged 1 commit into
masterfrom
chore/docs-workspace-satellites
Nov 21, 2026
Merged

rasuvaeff merged 1 commit into
masterfrom
chore/docs-workspace-satellites

Conversation

@rasuvaeff

@rasuvaeff rasuvaeff commented Nov 21, 2026 •

Copy link
Copy Markdown
Owner

Docs Build went red after today's satellite releases: composer outdated --direct --strict in docs/.api-workspace (see AGENTS.md: the lock moves with every satellite release).

  • constraints: understudy-testo ^1.2, understudy-psalm ^1.3, understudy-phpstan ^1.2
  • path repository version for core 1.0.0 → 1.2.1 (the new satellites require core ^1.2)
  • make docs-api regenerated: new rows understudy.rest and UnderstudyRestSuggestion on /api/rules

Summary by Sourcery

Align the documentation workspace with the latest satellite releases and regenerate its public API documentation.

New Features:

  • Document the newly released understudy.rest PHPStan rule and UnderstudyRestSuggestion Psalm issue.

Bug Fixes:

  • Restore the docs workspace's strict dependency checks after the satellite releases.

Enhancements:

  • Update generated API documentation to reflect the released Understudy 1.2.1, PHPStan 1.2, Psalm 1.3, and Testo 1.2 APIs.

Build:

  • Align the docs workspace dependency constraints, lockfile, and local core package version with the released satellites.

Documentation:

  • Regenerate API and rules documentation for the released package versions, including updated version metadata and rule listings.

understudy-testo 1.2.0, understudy-psalm 1.3.0 and understudy-phpstan 1.2.0
need core ^1.2, so the path repository now reports core as 1.2.1; the API
and rules pages are regenerated (new understudy.rest and
UnderstudyRestSuggestion rows).
@sourcery-ai

sourcery-ai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Sorry @rasuvaeff, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 11 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@coderabbitai

coderabbitai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 70c619b8-ac63-44ac-91c1-f0b784a0be40
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@sourcery-ai

sourcery-ai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Reviewer's Guide

Configuration

Update the docs workspace constraints and core path-repository version for the released satellites, with the lock file recording the resolved dependency set.

  • docs/.api-workspace/composer.json L8-11, L19
  • docs/.api-workspace/composer.lock L2802-2811, L3524-3533, L3724-3737 (+10 small edits)

Documentation

Regenerate the API snapshots and published API pages from the released satellites, including the new PHPStan rule and Psalm issue.

  • docs/scripts/api-snapshot.json L14682-14814, L15357-15533, L17854-18168 (+271 small edits)
  • docs/scripts/rules-snapshot.json L42-48, L68-73 (+2 small edits)
  • docs/src/api/classes/Arg.md L12
  • docs/src/api/classes/Captor.md L12
  • docs/src/api/classes/Exception/AmbiguousDefaultFactory.md L12
  • docs/src/api/classes/Exception/BypassUnavailable.md L12
  • docs/src/api/classes/Exception/CannotWire.md L12
  • docs/src/api/classes/Exception/ConflictingExpectation.md L12
  • docs/src/api/classes/Exception/ContextOwnershipViolation.md L12
  • docs/src/api/classes/Exception/ForgottenDouble.md L12
  • docs/src/api/classes/Exception/ForwardingTargetMismatch.md L12
  • docs/src/api/classes/Exception/InvalidCallSpecification.md L12
  • docs/src/api/classes/Exception/InvalidDefaultValue.md L12
  • docs/src/api/classes/Exception/InvalidSpecificationArgument.md L12
  • docs/src/api/classes/Exception/MatcherLeaked.md L12
  • docs/src/api/classes/Exception/NeverMethodCalled.md L12
  • docs/src/api/classes/Exception/NoDefaultValue.md L12
  • docs/src/api/classes/Exception/NothingCaptured.md L12
  • docs/src/api/classes/Exception/OriginalCallUnavailable.md L12
  • docs/src/api/classes/Exception/OriginalReturnTypeViolation.md L12
  • docs/src/api/classes/Exception/OutcomeUnavailable.md L12
  • docs/src/api/classes/Exception/StrictModeViolation.md L12
  • docs/src/api/classes/Exception/UnderstudyError.md L12
  • docs/src/api/classes/Exception/UnsupportedTarget.md L12
  • docs/src/api/classes/Exception/VerificationFailed.md L12
  • docs/src/api/classes/ExpectBuilder.md L12
  • docs/src/api/classes/FailureKind.md L12
  • docs/src/api/classes/Invocation.md L12
  • docs/src/api/classes/Psalm/Issue/UnderstudyMisuse.md L12
  • docs/src/api/classes/Psalm/Issue/UnderstudyRestSuggestion.md L1-29
  • docs/src/api/classes/Psalm/Plugin.md L12
  • docs/src/api/classes/StrictStubs.md L12
  • docs/src/api/classes/Testo/UnderstudyInterceptor.md L12, L45
  • docs/src/api/classes/Testo/UnderstudyPlugin.md L12, L30-32
  • docs/src/api/classes/Understudy.md L12
  • docs/src/api/classes/VerificationFailure.md L12
  • docs/src/api/classes/WhenBuilder.md L12
  • docs/src/api/index.md L16, L71
  • docs/src/api/rules.md L12-21, L39-44

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rasuvaeff
rasuvaeff merged commit 1380481 into master Nov 21, 2026
27 checks passed
@rasuvaeff
rasuvaeff deleted the chore/docs-workspace-satellites branch November 21, 2026 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant