Skip to content

docs(release): require one shared product version - #297

Merged
DecisionNerd merged 1 commit into
mainfrom
docs/292-shared-release-version
Aug 1, 2026
Merged

DecisionNerd merged 1 commit into
mainfrom
docs/292-shared-release-version

Conversation

@DecisionNerd

@DecisionNerd DecisionNerd commented Aug 1, 2026 •

Copy link
Copy Markdown
Contributor

Closes #292.

Summary

  • accept ADR 0017: all public Rust crates, Python/Node/native adapters, CLI, and skills share one exact release version
  • document coordinated recovery and preserve immutable partial-release records
  • make repository preflight and candidate tests reject adapter/core version divergence
  • publish ADR 0017 through both decision indexes and the Starlight allowlist/navigation

Validation

  • python3 scripts/ci/test-release-publish-preflight.py
  • python3 scripts/ci/test-release-candidate.py
  • python3 scripts/set_release_version.py --check
  • pnpm docs:build
  • pnpm docs:check-links
  • make pre-push-fast

No versions, tags, releases, packages, or registry state are changed.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • Documentation

    • Added the “Unified Release Version” architecture decision record to the published documentation and navigation.
  • Tests

    • Added coverage ensuring release validation rejects artifacts with mismatched versions.
    • Added coverage for registry-specific Node version mismatches during publish preflight validation.

Note

Document and enforce a single shared product version across all release surfaces

  • Adds ADR 0017 establishing that Rust crates, Python/Node adapters, CLI, and agent skills must share one version at every release, forbidding registry-specific patch versions.
  • Updates release process, publication order, and v0.5.0 operator runbook docs to reference ADR 0017 and describe valid recovery dispositions.
  • Adds test cases in test-release-candidate.py and test-release-publish-preflight.py that assert validation fails when any adapter version diverges from the expected release version.
  • Registers ADR 0017 in the docs site sidebar and content sync allowlist so it appears in the published documentation.

Macroscope summarized 9aad072.

@coderabbitai

coderabbitai Bot commented Aug 1, 2026 •

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The documentation site now publishes ADR 0017 and links it in ADR navigation. Release validation tests cover mismatched npm artifact versions and registry-specific Node versions.

Changes

Unified Release Version

Layer / File(s) Summary
Publish ADR 0017
docs-site/astro.config.mjs, docs-site/scripts/sync-content.mjs
ADR 0017 is added to navigation and the published documentation page list. The allowlist comment reflects the accepted ADR set.
Validate version unity
scripts/ci/test-release-candidate.py, scripts/ci/test-release-publish-preflight.py
Regression tests reject npm artifact and Node registry version mismatches.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

Suggested labels: core, testing

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive Regression tests and documentation publishing updates are evidenced, but core ADR and release-guidance requirements are in filtered Markdown files. Review the excluded ADR, release-guidance, runbook, index, and changelog files to verify all issue #292 acceptance criteria.
✅ Passed checks (4 passed)
Check name Status Explanation
Out of Scope Changes check ✅ Passed All summarized changes support ADR 0017 publication or regression coverage for shared release-version validation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the main change: enforcing one shared product version across release surfaces.
Description check ✅ Passed The description clearly covers the objective, implementation areas, validation commands, linked issue, and release impact.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/292-shared-release-version

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

@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling Developer tooling and automation release:none No release note or version impact labels Aug 1, 2026
@DecisionNerd
DecisionNerd merged commit dd67a97 into main Aug 1, 2026
20 checks passed
@DecisionNerd
DecisionNerd deleted the docs/292-shared-release-version branch August 1, 2026 13:24
This was referenced Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation release:none No release note or version impact tooling Developer tooling and automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(adr): require one version across GraphForge core and adapters

1 participant