From adfc7b70aaac29485343649ba17be8f32c02cc85 Mon Sep 17 00:00:00 2001 From: harshitha-cstk Date: Thu, 23 Jul 2026 15:57:55 +0530 Subject: [PATCH] docs: document launch opt-in requirement in 2.x migration guide (DX-9748) Add a migration section and troubleshooting entry to MIGRATION.md covering that launch:* commands are no longer bundled in 2.x GA and require installing @contentstack/cli-launch explicitly. Calls out that this is a change relative to the 2.x beta too (launch was bundled throughout 1.x and the beta), so running launch:* without the plugin now fails with "command not found". Co-Authored-By: Claude Opus 4.8 --- MIGRATION.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/MIGRATION.md b/MIGRATION.md index 7853bc0d8a..e9eaf9147d 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -189,6 +189,45 @@ csdx cm:entries:publish --content-types blog --environments prod --locales en-us csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us -k blt123 ``` +### 7. 🚀 Launch Plugin Now Opt-In + +**What Changed:** +- The `launch` plugin (`@contentstack/cli-launch`) is no longer bundled with the CLI +- All `launch:*` commands now require installing the plugin explicitly before use +- Brings `launch` in line with the opt-in, modular plugin model used elsewhere in 2.x + +> ⚠️ **This is a change relative to the 2.x beta — not only relative to 1.x.** `@contentstack/cli-launch` was bundled throughout the 1.x releases **and** the entire 2.x beta period, so `launch:*` worked out of the box for beta users too. Starting with 2.x GA it becomes opt-in, so beta users who rely on `launch:*` are also affected when they upgrade. + +**Before (1.x.x and 2.x.x-beta):** +- `launch:*` commands were bundled with the CLI and available by default after installation + +**After (2.x.x GA):** +- `launch:*` commands are provided by a separate, opt-in plugin that must be installed explicitly +- Running any `launch:*` command without the plugin installed fails with a `command not found` error where it previously worked out of the box + +**Affected commands:** `launch`, `launch:deployments`, `launch:environments`, `launch:functions`, `launch:logs`, `launch:open`, `launch:rollback` + +**Installation Methods:** + + +**Option 1: Using CLI Plugin Manager** +```bash +csdx plugins:install @contentstack/cli-launch +``` + +**Option 2: Using npm** +```bash +npm install -g @contentstack/cli-launch +``` + +**Usage:** +After installation, launch commands will be available through the CLI: +```bash +csdx launch --help +``` + +**Migration Action:** If you use any `launch:*` command, install the `@contentstack/cli-launch` plugin before (or immediately after) upgrading to 2.x GA to avoid `command not found` errors. This applies to 2.x beta users as well, since `launch` was bundled during the beta. + ## Troubleshooting ### Common Issues @@ -209,6 +248,11 @@ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environme - The 2.x.x-beta version should be faster due to TypeScript modules - If you are experiencing issues, switch to console log mode for debugging +**5. `launch:*` command not found:** +- In 2.x GA, `launch` is an opt-in plugin and is no longer bundled (it was bundled in 1.x and during the 2.x beta) +- Install it with `csdx plugins:install @contentstack/cli-launch`, then re-run your `launch:*` command +- Verify it is installed with `csdx plugins` + ### Getting Help **Documentation:**