Skip to content

Fix automated version release validation - #14

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/release-baseline-version
Jul 31, 2026
Merged

Fix automated version release validation#14
tannerlinsley merged 1 commit into
mainfrom
taren/release-baseline-version

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

  • use workspace source revisions instead of package versions for TanStack bundle provenance
  • synchronize release-facing README, docs, evidence links, and marketing copy in Changesets version PRs
  • regenerate package docs from the canonical root docs

Validation

  • pnpm run validate
  • pnpm benchmark:check
  • focused release, docs, provenance, and friction contracts

Summary by CodeRabbit

  • Documentation

    • Clarified that comparison results reflect the exact released workspace source and pinned competitor versions.
    • Documented updated bundle-baseline validation and release documentation workflows.
  • New Features

    • Added automated synchronization of release versions across documentation and marketing references.
  • Bug Fixes

    • Workspace version changes no longer invalidate unchanged comparison measurements.
    • External package versions continue to require exact baseline matches.
  • Tests

    • Added coverage for source-revision validation, version synchronization, and release workflow checks.

@tannerlinsley
tannerlinsley merged commit 44a4aaf into main Jul 31, 2026
22 checks passed
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a217ab29-21b9-46e1-8cc2-ee075baff759

📥 Commits

Reviewing files that changed from the base of the PR and between 170b465 and 81c7359.

📒 Files selected for processing (13)
  • API-FRICTION.md
  • benchmarks/comparison/README.md
  • docs/comparison.md
  • package.json
  • packages/charts-core/docs/comparison.md
  • scripts/compare-chart-libraries.mjs
  • scripts/comparison-source-revision.mjs
  • scripts/comparison-source-revision.test.mjs
  • scripts/docs-contract.mjs
  • scripts/docs-contract.test.mjs
  • scripts/release-workflow.test.mjs
  • scripts/sync-release-version.mjs
  • scripts/sync-release-version.test.mjs

📝 Walkthrough

Walkthrough

The change updates comparison baseline provenance rules and adds automated release-version synchronization. Workspace comparisons use source revisions, external packages retain exact version checks, and release documentation updates run from the changeset:version workflow.

Changes

Comparison provenance and release synchronization

Layer / File(s) Summary
Comparison provenance validation
scripts/comparison-source-revision.mjs, scripts/compare-chart-libraries.mjs, scripts/docs-contract.mjs, scripts/*test.mjs, benchmarks/comparison/README.md, docs/comparison.md, packages/charts-core/docs/comparison.md, API-FRICTION.md
Workspace version changes no longer require exact baseline package-version matches. Comparison checks use source revisions for workspace sources and retain exact version checks for external packages.
Release version synchronization
scripts/sync-release-version.mjs, scripts/sync-release-version.test.mjs, package.json, scripts/release-workflow.test.mjs, API-FRICTION.md
The release workflow derives current and previous versions from CHANGELOG.md, validates configured references, updates them idempotently, and runs documentation synchronization during changeset:version.

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

Sequence Diagram(s)

sequenceDiagram
  participant ChangesetVersion as changeset:version
  participant SyncReleaseVersion as syncReleaseVersion
  participant Changelog as CHANGELOG.md
  participant ReleaseDocs as configured release documentation files
  participant DocsSync as docs:sync
  ChangesetVersion->>SyncReleaseVersion: synchronize release references
  SyncReleaseVersion->>Changelog: read current and previous versions
  SyncReleaseVersion->>ReleaseDocs: validate and replace previous version
  ChangesetVersion->>DocsSync: regenerate package documentation
Loading

Possibly related PRs

  • TanStack/charts#5: Both changes modify comparison baseline provenance and version validation.
  • TanStack/charts#6: Both changes use release evidence and changelog version metadata.
  • TanStack/charts#12: Both changes extend the release-version synchronization workflow.
✨ 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 taren/release-baseline-version

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

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

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