Skip to content

fix(docs): bump the docs version pin to 0.78.0#386

Merged
Tjemmmic merged 1 commit into
mainfrom
fix/docs-version-pin-0.78.0
Jun 25, 2026
Merged

fix(docs): bump the docs version pin to 0.78.0#386
Tjemmmic merged 1 commit into
mainfrom
fix/docs-version-pin-0.78.0

Conversation

@Tjemmmic

Copy link
Copy Markdown
Contributor

Follow-up to the 0.78.0 release (#385).

Problem

#385 bumped package.json to 0.78.0 but didn't update the docs version pin, which a release is supposed to do together. The docs:freshness gate (CLASS 1 — the **Version X.Y.Z** header must equal package.json) therefore fails on main, reddening ci.yml.

This is docs-only and does not affect the published package: publish.yml's verify job doesn't run docs:check, so @tangle-network/agent-runtime@0.78.0 published correctly and is unaffected — only the repo's CI freshness gate is red.

Fix

  • docs/canonical-api.md: **Version 0.77.0** → **0.78.0** (curated header).
  • docs/api/primitive-catalog.md: regenerated via pnpm run docs:api (the generated GENERATED from …@0.78.0 line).

Validation

pnpm run docs:check → exit 0 (version pin present + accurate, no drift).

The 0.78.0 release (#385) bumped package.json but not the docs version pin, so
the docs:freshness gate (version header must equal package.json) failed on main.
Update the canonical-api.md '**Version**' header and regenerate
docs/api/primitive-catalog.md (the generated 'GENERATED from …@0.78.0' line).

@tangletools tangletools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Auto-approved PR — 8aca914a

Blanket team auto-approval is enabled for this reviewer service.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.

tangletools · auto-approval · reason: blanket_auto_approve · 2026-06-25T03:53:04Z

@Tjemmmic

Tjemmmic commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

🤖 AI Code Review (ensemble)

Resolution (8aca914): 2 not an issue.

Summary

This PR bumps the documented agent-runtime version pin from 0.77.0 to 0.78.0 in two files, but the generated file docs/api/primitive-catalog.md is explicitly marked as auto-generated with a CI freshness gate that enforces consistency with the source. Hand-editing the version pin instead of running pnpm run docs:api risks CI failure if the underlying package.json does not match or if the freshness gate detects the drift.

Issues Found

2 total — 0 P1 (blocking) · 2 P2 (should fix) · 0 P3 (nice to have)

⚠️ P2 — Generated file hand-edited instead of regeneratedNot an issue

Note: primitive-catalog.md was regenerated with pnpm run docs:api (commit 8aca914), not hand-edited. Proof: docs:check runs docs:api && git diff --exit-code -- docs/api, so a fresh regen producing exactly the committed bytes is the gate — and it passes (the CI "Docs … freshness gate" step is green). The 1-line diff is expected: nothing else in the catalog changed since 0.77.0 (no source export/signature changes), so only the GENERATED from …@0.78.0 line moves. package.json is 0.78.0 (#385 merged).

  • File: docs/api/primitive-catalog.md:L10
  • Problem: The file header explicitly states 'GENERATED from @tangle-network/agent-runtime@0.78.0 ... Do NOT hand-edit — run pnpm run docs:api.' This PR hand-edits the version string directly in a generated file. If the underlying package.json has not been bumped to 0.78.0, or if the freshness gate (pnpm docs:freshness) detects the drift, CI will fail. The absence of any other changes (export inventory, per-symbol summaries, file:line references) suggests the regeneration script was never run — either the bump is premature or the version pin is cosmetic and needs verification.
  • Fix: Run pnpm run docs:api to regenerate the catalog from the actual 0.78.0 source and commit the full diff. Verify pnpm docs:freshness passes locally before merging. If only the version string changed, note that in the PR description.

⚠️ P2 — Version pin hand-edited despite freshness gate enforcementNot an issue

Note: The docs:freshness gate (CLASS 1) checks the curated **Version X.Y.Z** headers + the generated catalog against package.json — both are updated here, and the gate passes in CI. There are no other 0.77.0 references left in docs/ (verified: grep -rn 0.77.0 docs/ → none). Historical/changelog references elsewhere are intentionally not version pins and are out of the gate's scope. CI is green, so no drift remains.

  • File: docs/canonical-api.md:L5
  • Problem: The HTML comment on L4 states the freshness gate 'FAILS CI if a version pin, a cited file:line, a decision-table symbol, or the generated catalog drifts from source.' This PR updates only two of potentially several locations where the version is pinned. If there are other 0.77.0 references in the repo that were not updated, or if the underlying package.json still references 0.77.0, CI will fail.
  • Fix: Search the entire repository for 0.77.0 references and update all consistently, or run the documented generation tooling. Verify pnpm docs:freshness passes locally before merging.

✅ APPROVE

Status: both P2s are speculative ("if CI fails…") and did not materialize — CI is green, including the docs freshness gate. No changes needed; docs-only version-pin bump for the 0.78.0 release.

Reviewer A raises valid concerns about hand-editing generated files and potential CI freshness-gate failures, but these are speculative — the diff itself shows no correctness, security, or API-contract issues. The version bump may be the correct and complete change, and CI will catch any drift. With only 2 P2 issues and no P1s, the threshold for CHANGES_REQUESTED is not met. CI is the authoritative check here; the author should ensure it passes.

Quick Reference

  • P2: Generated file hand-edited instead of regenerated
  • P2: Version pin hand-edited despite freshness gate enforcement

Synthesized by Sokuza AI from multiple independent reviewers

@Tjemmmic Tjemmmic merged commit 28a0984 into main Jun 25, 2026
1 check passed
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.

2 participants