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:** diff --git a/packages/contentstack/README.md b/packages/contentstack/README.md index d3477ee4d1..9b449ee445 100644 --- a/packages/contentstack/README.md +++ b/packages/contentstack/README.md @@ -76,13 +76,6 @@ USAGE * [`csdx config:set:rate-limit`](#csdx-configsetrate-limit) * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) * [`csdx help [COMMAND]`](#csdx-help-command) -* [`csdx launch`](#csdx-launch) -* [`csdx launch:deployments`](#csdx-launchdeployments) -* [`csdx launch:environments`](#csdx-launchenvironments) -* [`csdx launch:functions`](#csdx-launchfunctions) -* [`csdx launch:logs`](#csdx-launchlogs) -* [`csdx launch:open`](#csdx-launchopen) -* [`csdx launch:rollback`](#csdx-launchrollback) * [`csdx login`](#csdx-login) * [`csdx logout`](#csdx-logout) * [`csdx plugins`](#csdx-plugins) @@ -1681,283 +1674,13 @@ DESCRIPTION _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.53/src/commands/help.ts)_ -## `csdx launch` - -Launch related operations - -``` -USAGE - $ csdx launch [-d ] [-c ] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create - React App)|CSR (Client-Side Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other] [--org ] [-n ] [-e - ] [--branch ] [--build-command ] [--out-dir ] [--server-command ] - [--variable-type Import variables from a stack|Manually add custom variables to the list|Import variables from the - .env.local file|Skip adding environment variables...] [-a ] [--env-variables ] [--redeploy-latest] - [--redeploy-last-upload] [--response-mode buffered|streaming] - -FLAGS - -a, --alias= [optional] Alias (name) for the delivery token. - -c, --config= Path to the local '.cs-launch.json' file - -d, --data-dir= Current working directory - -e, --environment= [optional] Environment name for the Launch project. - -n, --name= [optional] Name of the project. - --branch= [optional] GitHub branch name. - --build-command= [optional] Build Command. - --env-variables= [optional] Provide the environment variables in the key:value format, separated by - comma. For example: APP_ENV:prod, TEST_ENV:testVal. - --framework=