Skip to content

docs(release): refresh version-bearing docs and registry status to 4.1.0 - #48

Merged
GQAdonis merged 4 commits into
mainfrom
docs/release-status-4.1.0
Oct 8, 2026
Merged

GQAdonis merged 4 commits into
mainfrom
docs/release-status-4.1.0

Conversation

@GQAdonis

@GQAdonis GQAdonis commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Documentation site workflow fails on main at "Validate documentation and README contracts". The 4.0.x and 4.1.0 releases skipped the release procedure's "refresh version-bearing docs" phase, so:

  • the release guide and README still described twelve packages at 3.2.0, while the release contract lists thirteen npm artifacts (entity-graph-react joined in 4.0.0);
  • release/npm-registry-status.json and the packed API inventory were twelve packages at 3.2.0;
  • release/pubdev-registry-status.json recorded Flutter 3.1.0 although 4.0.0 has been live on pub.dev since 2026-09-05 (and the contract already said 4.0.0, so readme:write refused to run).

This brings the data files to the real registry state (npm 4.1.0 ×13, pub.dev 4.0.0; archive SHA taken from the pub.dev API), regenerates everything derived from them (readme:write, docs:api, docs:search), and sweeps the hand-written prose (README, RELEASING, Docusaurus announcement, website docs) to 4.1.0 / thirteen packages / Flutter 4.0.0. The package chooser gains the prometheus-entity-management compatibility-alias row so it lists every contract artifact.

Two test expectations were stale and are updated: the package count (12 → 13) and the React guide install assertion, which still named the pre-4.0 package.

Test plan

  • pnpm --filter @prometheus-ags/entity-management-docs test: 19/19 (was 17/19).
  • pnpm run verify:readme-parity passes for 13 packages (fails on main).
  • Both documentation sites build (website and site).
  • docs:artifacts:check passes after re-reviewing three drifted evidence screenshots and regenerating the gallery (second commit; needs the merged a2ui fix fix(examples): repair the agentic-a2ui showcase and regenerate its evidence (ci:validate) #50, which this branch is rebased on).
  • Documentation site workflow green after the a2ui fix lands.

🤖 Generated with Claude Code

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T10:58:14.744836Z 36af5d4 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 36af5d44d7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread examples/coverage.json
{
"schemaVersion": "1.0.0",
"release": "4.0.0",
"release": "4.1.0",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Align the coverage release with the canonical contract

When pnpm run validate:release-contract evaluates this commit, validateReleaseCoverage compares this value with release/v3-release-contract.json's release.version, which remains 4.0.0, and reports a mismatch at scripts/validate-v3-release-contract.mjs:95-97. Consequently the release validation gate cannot pass until the canonical release version is updated to 4.1.0 or this ledger remains aligned at 4.0.0.

Useful? React with 👍 / 👎.

Comment on lines 15 to +17
Use the [package chooser](chooser.md) to select a binding or integration. The
verified registry snapshot has all twelve npm packages public at stable
`3.2.0`:
verified registry snapshot has all thirteen npm packages public at stable
`4.1.0`:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Refresh the package page's release details

For users consulting this page for the current release, the new 4.1.0 claim is immediately contradicted by the table and installation prose below: npm packages are still listed at 3.2.0, Flutter at 3.1.0, and the table still summarizes only twelve npm packages. This makes the advertised verified registry snapshot inaccurate; refresh the entire release block to match the committed npm 4.1.0 and Flutter 4.0.0 registry-status files.

Useful? React with 👍 / 👎.

Comment on lines +79 to +81
id: 'v4_stable',
content:
'<strong>3.2.0 stable</strong> — all twelve npm packages are public on npm at 3.2.0, including the optional React DevTools inspector. Flutter 3.1.0 is public on pub.dev with its official DevTools companion.',
'<strong>4.1.0 stable</strong> — all thirteen npm packages are public on npm at 4.1.0, including the optional React DevTools inspector and the entity-graph-react binding. Flutter 4.0.0 is public on pub.dev with its official DevTools companion.',

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Move the current docs navigation to the 4.x line

After announcing 4.1.0 as the current release, the same configuration still exposes current as label/path 3.x and hard-codes every navbar destination under /docs/3.x/. Thus the deployed site presents the refreshed 4.x content as the 3.x documentation line, contradicting the updated start page and version selector; either publish a 4.x route/version with redirects for old URLs or avoid declaring the active documentation line as 4.x.

Useful? React with 👍 / 👎.

@GQAdonis
GQAdonis force-pushed the docs/release-status-4.1.0 branch from 36af5d4 to 61d844a Compare October 8, 2026 11:35
GQAdonis and others added 2 commits October 8, 2026 06:53
The 4.0.x and 4.1.0 releases skipped the "refresh version-bearing docs" phase
of the release procedure, so the documentation contract tests
(website/tests/site-contract.test.mjs, run by the Documentation site
workflow's "Validate documentation and README contracts" step) failed on main:
the release guide rows still described twelve packages at 3.2.0 while the
release contract lists thirteen npm artifacts (entity-graph-react joined in
4.0.0), and the packed API inventory was twelve packages at 3.2.0.

- release/npm-registry-status.json: 13 packages, latest and next at 4.1.0,
  candidate source 6a27c20 (the published tree), release URL v4.1.0.
- release/pubdev-registry-status.json: entity_graph_flutter 4.0.0 as live on
  pub.dev since 2026-09-05 (archive SHA from the pub.dev API); the contract
  already said 4.0.0 and readme-parity refused the 3.1.0 record.
- release/v3-release-contract.json: npm fixed version 4.1.0; policy prose.
- examples/coverage.json + schema: release 4.1.0.
- Regenerated: README/release-guide generated blocks (readme:write), the
  packed API reference and inventory for 13 packages (docs:api), the search
  index (docs:search).
- Hand-written prose in README, RELEASING, the Docusaurus announcement and
  the website docs now state 4.1.0 / thirteen packages / Flutter 4.0.0; the
  package chooser gains the prometheus-entity-management compatibility-alias
  row; Flutter install pins move to ^4.0.0.
- website/tests/site-contract.test.mjs: thirteen packages; the React guide
  install assertion names entity-graph-react, which the guide has used since
  4.0.0.

Verified: website doc-contract tests 19/19, verify:readme-parity passes,
both documentation sites build. docs:artifacts:check still needs the
agentic-a2ui evidence (separate fix) before it can pass.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ence gallery

docs:artifacts:check failed after the inventory fix because three
allowlisted evidence sources no longer matched their reviewed hashes:
next-ssr-hydration (screenshot and receipt recommitted in 486880c without
re-review) and the two agentic-a2ui screenshots regenerated by the showcase
repair. All three were reviewed again against the allowlist criteria
(no visible secrets, no internal paths, not blank, not an icon); the
allowlist and certification records carry the new hashes and docs:evidence
rebuilt the manifest, originals and webp derivatives (15 assets).

docs:artifacts:check now passes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@GQAdonis
GQAdonis force-pushed the docs/release-status-4.1.0 branch from 61f75c2 to 197abe3 Compare October 8, 2026 11:53
GQAdonis and others added 2 commits October 8, 2026 06:59
ci:validate compares examples/coverage.json's release with the contract's
top-level release.version and refused 4.1.0 vs 4.0.0. test:release-contract
17/17; ci:validate exits 0.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…rsion (4.0.0)

ci:skills' Dart ledger check follows release/pubdev-registry-status.json,
which this branch corrects from 3.1.0 to the live 4.0.0; regenerated with
pnpm run refresh:dart-exports (only publishedArchiveVersion changes).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@GQAdonis
GQAdonis merged commit a36f657 into main Oct 8, 2026
5 of 6 checks passed
@GQAdonis
GQAdonis deleted the docs/release-status-4.1.0 branch October 8, 2026 12:28
GQAdonis added a commit that referenced this pull request Oct 8, 2026
The Documentation site workflow's packed-API input hash drifted after #52
changed the React dist and #54 bumped the packages to 4.1.1: the inventory
regenerated for 4.1.0 no longer described the built declarations. Same
refresh as #48, for the 4.1.1 candidate (c5a3a10):

- release/npm-registry-status.json: 13 packages at 4.1.1 on latest and next,
  candidate source c5a3a10, release URL v4.1.1.
- release/v3-release-contract.json release.version and npm fixed version,
  examples/coverage.json + schema: 4.1.1.
- Regenerated: packed API reference and inventory (13 packages), README and
  release-guide generated blocks, search index.
- Hand-written release prose (README, RELEASING, announcement, website docs)
  states 4.1.1; the 4.1.0 GC fix stays as history.

Website doc-contract tests 19/19, readme parity, ci:validate,
test:release-contract 17/17 and the website build all pass.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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