Release PHP 2.1.1 with canonical futures examples

[karlwaldman]

Summary

• replace venue-specific Brent paths in every customer-visible Composer surface with the canonical instrument route
• scan every readable file in the exact installed Composer distribution for mutable product/quota claims, including future nested package data
• harden CI with immutable action commits, non-persisted checkout credentials, and PR exclusion for authenticated live smoke
• prepare patch release 2.1.1

Red-green evidence

• RED: new future package-data fixture detected the previous hard-coded discovery gap; six independent request/call cadence aliases failed before the invariant detector existed
• GREEN: vendor/bin/phpunit --testdox (25 tests, 303 assertions)
• GREEN: composer validate --strict
• GREEN: bash scripts/clean-install-smoke.sh (16 exact installed text surfaces; success plus missing config/401/403/429 recovery)
• GREEN: authenticated production /v1/futures/brent/curve returned 14 contracts without exposing credentials

Release contract

• version: 2.1.1
• exact head: bbaee3c
• no fixed offer, catalog, entitlement, cadence, or allowance is introduced; mutable facts remain linked to the reviewed Product Facts contract
• no lifecycle/customer messages

Summary by CodeRabbit

• New Features

  • Updated to SDK version 2.1.1.
  • Added support for the instrument-generic Brent futures curve endpoint.

• Bug Fixes

  • Corrected packaged examples and tests to use the current Brent futures path.
  • Improved validation of public request-cadence claims.

• Documentation

  • Updated README and client examples with the current endpoint.

• Chores

  • Strengthened CI security and reliability with pinned actions, read-only permissions, and improved credential handling.

[coderabbitai]

Warning

Review limit reached

@karlwaldman, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 40 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 663faa34-a8fe-48b9-9f18-3a22d95740a2

📥 Commits

Reviewing files that changed from the base of the PR and between bbaee3c and 33705c5.

📒 Files selected for processing (3)

• .github/workflows/test.yml
• scripts/validate-public-claims.php
• tests/PublicClaimsTest.php

📝 Walkthrough

Walkthrough

The release updates the SDK to version 2.1.1, changes Brent futures examples to a generic route, detects fixed request-cadence claims, strengthens CI controls, updates smoke-install defaults, and expands regression tests.

Changes

SDK release validation

Layer / File(s)	Summary
Brent endpoint and SDK version updates src/Client.php, src/RawClient.php, README.md, tests/ClientTest.php, tests/PublicClaimsTest.php	Examples and raw endpoint tests now use /v1/futures/brent/curve. The client version and related assertions now use 2.1.1.
Fixed request-cadence claim detection scripts/validate-public-claims.php, tests/PublicClaimsTest.php	Validation reports bounded text containing numeric counts, request actions, and cadence terms. Tests cover supported aliases and negative cases.
CI and release controls .github/workflows/test.yml, scripts/clean-install-smoke.sh, tests/PublicClaimsTest.php, CHANGELOG.md	CI actions are pinned, checkout credentials are not persisted, contents permission is read-only, live jobs exclude pull requests, and the smoke-install default is 2.1.1. Release notes document the changes.

Estimated code review effort: 3 (Moderate) | ~25 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 28.57% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the PHP 2.1.1 release and the main change to canonical futures examples.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/generic-futures-20260811

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/PublicClaimsTest.php`:
- Around line 127-140: The test
testWorkflowActionsArePinnedAndCheckoutCredentialsAreNotPersisted currently
validates persist-credentials: false only via global counts; update it to
inspect every actions/checkout step and assert each checkout configuration
contains its own persist-credentials: false setting, while retaining the
existing pinned-action assertions.
- Around line 114-125: Update
testPackagedSurfacesUseInstrumentGenericFuturesPaths to scan all packaged text
surfaces rather than relying on publicSurfaceFiles(), including Markdown, JSON,
and extensionless customer files. Reuse the installed archive text-file list or
the discovery mechanism used by the package-claim scan, while preserving the
existing venue-specific route assertion and diagnostic message.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9b8e0b60-cdbd-49a7-ae33-0fa249b11604

📥 Commits

Reviewing files that changed from the base of the PR and between f574f02 and bbaee3c.

📒 Files selected for processing (9)

• .github/workflows/test.yml
• CHANGELOG.md
• README.md
• scripts/clean-install-smoke.sh
• scripts/validate-public-claims.php
• src/Client.php
• src/RawClient.php
• tests/ClientTest.php
• tests/PublicClaimsTest.php