Skip to content

LTRAC-467: chore(create-catalyst) - Deprecate the integration command#3055

Merged
jorgemoya merged 1 commit into
canaryfrom
jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command
Jun 22, 2026
Merged

LTRAC-467: chore(create-catalyst) - Deprecate the integration command#3055
jorgemoya merged 1 commit into
canaryfrom
jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command

Conversation

@jorgemoya

Copy link
Copy Markdown
Contributor

Linear: LTRAC-467

What/Why?

Deprecates create-catalyst integration ahead of its eventual removal. The command builds integration patches by diffing git tags (@bigcommerce/catalyst-core@*), which relies on the merchant's project having full git history. Once projects are distributed as tarballs instead of git clones (LTRAC-409), that history won't exist and the command can't work. The catalyst upgrade command will subsume the use case (integrations publish tags; merchants target them with catalyst upgrade).

This ships the deprecation warning first on the stable (canary) line so we can cut a CLI release that warns users before the command is removed.

  • commands/integration.ts — prints a yellow deprecation warning when invoked (still runs for now), pointing at the future catalyst upgrade.
  • index.ts — registers the command with { hidden: true } so it no longer appears in --help (verified: --help now lists only create/init/telemetry).
  • Changeset (minor).

Testing

pnpm build, pnpm typecheck, pnpm lint, and pnpm test (8 tests) all pass in packages/create-catalyst. Verified against the built dist: --help hides integration, and invoking it prints the warning.

Migration

None for end users — the command still works, just warns and is hidden. Docs referencing create-catalyst integration should note the deprecation (follow-up).

Note

Full removal of the command is handled separately as part of the create-catalyst → catalyst consolidation (LTRAC-910, on the alpha line, which reduces create-catalyst to a thin catalyst create wrapper). This PR is the canary-line deprecation stopgap.

@jorgemoya
jorgemoya requested a review from a team as a code owner June 18, 2026 15:20
@changeset-bot

changeset-bot Bot commented Jun 18, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0ce2f4d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@bigcommerce/create-catalyst Minor

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

@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
catalyst Ready Ready Preview, Comment Jun 18, 2026 3:28pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

Bundle Size Report

Comparing against baseline from 226f2f3 (2026-06-18).

No bundle size changes detected.

@jorgemoya

jorgemoya commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

Testing:

❯ node dist/index.js --help

◢ @bigcommerce/create-catalyst v1.0.3

Usage: @bigcommerce/create-catalyst [options] [command]

A command line tool to create a new Catalyst project.

Options:
  -V, --version              output the version number
  -h, --help                 display help for command

Commands:
  create [options]           Command to scaffold and connect a Catalyst storefront to your BigCommerce store
  init [options]             Connect a BigCommerce store with an existing Catalyst project
  telemetry [options] [arg]
  help [command]             display help for command
~/dev/catalyst/packages/create-catalyst on  jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command [?]
❯ node dist/index.js integration demo

◢ @bigcommerce/create-catalyst v1.0.3

⚠ `create-catalyst integration` is deprecated and will be replaced by the `catalyst upgrade` command.
node:internal/errors:998

@jorgemoya
jorgemoya force-pushed the jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command branch from c1be226 to a2d23f1 Compare June 18, 2026 15:25
Print a deprecation warning when `create-catalyst integration` is invoked, and
hide it from `--help` (registered with { hidden: true }). The command builds
integration patches by diffing git tags, which won't work once Catalyst projects
ship as tarballs (no git history); it will be replaced by `catalyst upgrade`.
Still functional for now — full removal is a future major.

Refs LTRAC-467
Co-Authored-By: Claude <noreply@anthropic.com>
@jorgemoya
jorgemoya force-pushed the jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command branch from a2d23f1 to 0ce2f4d Compare June 18, 2026 15:27
@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Unlighthouse Performance Comparison — Vercel

Comparing PR preview deployment Unlighthouse scores vs production Unlighthouse scores.

Summary Score

Aggregate score across all categories as reported by Unlighthouse.

Prod Desktop Prod Mobile Preview Desktop Preview Mobile
Score 90 93 92 95

Category Scores

Category Prod Desktop Prod Mobile Preview Desktop Preview Mobile
Performance 73 81 72 83
Accessibility 95 98 95 92
Best Practices 100 100 100 100
SEO 88 88 100 100

Core Web Vitals

Metric Prod Desktop Prod Mobile Preview Desktop Preview Mobile
LCP 4.7 s 5.1 s 4.3 s 4.7 s
CLS 0.037 0 0.037 0
FCP 1.1 s 1.2 s 1.2 s 1.1 s
TBT 0 ms 0 ms 20 ms 10 ms
Max Potential FID 30 ms 40 ms 70 ms 60 ms
Time to Interactive 4.8 s 5.1 s 4.3 s 4.7 s

Full Unlighthouse report →

@jorgemoya
jorgemoya added this pull request to the merge queue Jun 22, 2026
Merged via the queue into canary with commit 854aab5 Jun 22, 2026
23 of 26 checks passed
@jorgemoya
jorgemoya deleted the jorgemoya/ltrac-467-deprecate-create-catalyst-integration-command branch June 22, 2026 14:41
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