LTRAC-466: feat(core) - Track Catalyst version in a dedicated package.json field#3056
Merged
jorgemoya merged 1 commit intoJun 22, 2026
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 8c5a648 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Bundle Size ReportComparing against baseline from No bundle size changes detected. |
….json field Add a `catalyst` field to core/package.json (`catalyst.version` + `catalyst.ref`) so the true Catalyst version is tracked independently of the top-level `version`, which merchants may repurpose (deploy tags, Docker labels). The backend user-agent now reports `catalyst.version`, falling back to `version` for projects created before the field existed. A release-time sync script (.github/scripts/sync-catalyst-version.mts), wired into the Changesets `version` step via the `changeset:version` root script, keeps `catalyst.version`/`catalyst.ref` in lockstep with each version bump. Refs LTRAC-466 Co-Authored-By: Claude <noreply@anthropic.com>
96b4c3c to
8c5a648
Compare
Contributor
Unlighthouse Performance Comparison — VercelComparing PR preview deployment Unlighthouse scores vs production Unlighthouse scores. Summary ScoreAggregate score across all categories as reported by Unlighthouse.
Category Scores
Core Web Vitals
|
chanceaclark
approved these changes
Jun 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linear: LTRAC-466
What/Why?
Adds a
catalystfield tocore/package.jsonso the true Catalyst version is tracked independently of the top-levelversion(merchants may repurposeversionfor deploy tags, Docker labels, etc.). This gives a stable source of truth for:catalyst upgradecommand (knowing which version/ref a project is based on), andChanges
core/package.json— adds thecatalystfield (mirrors the current1.7.0).core/user-agent.ts—backendUserAgentnow usespackageInfo.catalyst?.version ?? packageInfo.version. The fallback keeps it working for projects created before this field existed..github/scripts/sync-catalyst-version.mts(+ tests) — re-derivescatalyst.version/catalyst.reffromversion. Follows the repo's.mtsscript convention; idempotent (verified: re-running oncore/package.jsonproduces no diff).package.json—changeset:version=changeset version && node .github/scripts/sync-catalyst-version.mts..github/workflows/changesets-release.yml— points the Changesets action'sversion:step atpnpm changeset:version, so thecatalystfield is bumped in lockstep with every release (in the auto-generated Version Packages PR).@bigcommerce/catalyst-core: patch.Testing
pnpm test:scripts→ 139 passed (incl. 4 new for the sync script). Ran the sync script against the realcore/package.json: clean, idempotent, no reformatting.coretypecheck (which needs the env-gated GraphQLgeneratestep) runs in CI; theuser-agent.tschange is type-safe (catalyst?.version ?? version, bothstring).Review focus
version:→pnpm changeset:version) — please sanity-check it fits the release process. It only adds the sync step afterchangeset version; publish is unchanged.Migration
None for merchants. Existing projects without the field keep working via the user-agent fallback; the field appears on their next Catalyst upgrade.