From 9a884938127a73f13046fd521c2743ee935de716 Mon Sep 17 00:00:00 2001 From: Sarah Etter Date: Fri, 20 Dec 2024 15:23:25 -0500 Subject: [PATCH] feat!: remove addons subcommand (#6974) --- .gitignore | 2 - docs/commands/addons.md | 147 ---------------- site/src/_app.js | 2 - site/src/register-addon-thanks.md | 9 - site/src/register-addon.md | 96 ----------- src/commands/addons/addons-auth.ts | 28 --- src/commands/addons/addons-config.ts | 159 ------------------ src/commands/addons/addons-create.ts | 105 ------------ src/commands/addons/addons-delete.ts | 36 ---- src/commands/addons/addons-list.ts | 42 ----- src/commands/addons/addons.ts | 81 --------- src/commands/addons/index.ts | 1 - src/commands/main.ts | 3 - src/utils/addons/prepare.ts | 93 +--------- src/utils/addons/render.ts | 41 ----- .../commands/addons/addons.test.js | 158 ----------------- 16 files changed, 1 insertion(+), 1002 deletions(-) delete mode 100644 docs/commands/addons.md delete mode 100644 site/src/register-addon-thanks.md delete mode 100644 site/src/register-addon.md delete mode 100644 src/commands/addons/addons-auth.ts delete mode 100644 src/commands/addons/addons-config.ts delete mode 100644 src/commands/addons/addons-create.ts delete mode 100644 src/commands/addons/addons-delete.ts delete mode 100644 src/commands/addons/addons-list.ts delete mode 100644 src/commands/addons/addons.ts delete mode 100644 src/commands/addons/index.ts delete mode 100644 src/utils/addons/render.ts delete mode 100644 tests/integration/commands/addons/addons.test.js diff --git a/.gitignore b/.gitignore index 2be24777c50..fc6de3a7e59 100644 --- a/.gitignore +++ b/.gitignore @@ -26,8 +26,6 @@ test-site site/dist site-cra site/src/**/*.md -!site/src/register-addon.md -!site/src/register-addon-thanks.md # tests .verdaccio-storage diff --git a/docs/commands/addons.md b/docs/commands/addons.md deleted file mode 100644 index f0f79e48305..00000000000 --- a/docs/commands/addons.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Netlify CLI addons command ---- - -# `addons` - -The addons command will manage Netlify addons. - -For more information on add-ons see our [Netlify partner add-ons docs](https://docs.netlify.com/integrations/partner-add-ons/get-started/) - -## About - -> ⚠️ The addons command is [deprecated](https://docs.netlify.com/platform/release-phases/#deprecated) and will become unavailable in a future update. - -**Usage** - -```bash -netlify addons -``` - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `debug` (*boolean*) - Print debugging information - -| Subcommand | description | -|:--------------------------- |:-----| -| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | -| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | -| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | - - -**Examples** - -```bash -netlify addons:create addon-xyz -netlify addons:list -netlify addons:config addon-xyz -netlify addons:delete addon-xyz -netlify addons:auth addon-xyz -``` - ---- -## `addons:auth` - -Login to add-on provider - -**Usage** - -```bash -netlify addons:auth -``` - -**Arguments** - -- name - Add-on slug - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `debug` (*boolean*) - Print debugging information - ---- -## `addons:config` - -Configure add-on settings - -**Usage** - -```bash -netlify addons:config -``` - -**Arguments** - -- name - Add-on namespace - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `debug` (*boolean*) - Print debugging information - ---- -## `addons:create` - -Add an add-on extension to your site -Add-ons are a way to extend the functionality of your Netlify site - -**Usage** - -```bash -netlify addons:create -``` - -**Arguments** - -- name - Add-on namespace - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `debug` (*boolean*) - Print debugging information - ---- -## `addons:delete` - -Remove an add-on extension to your site -Add-ons are a way to extend the functionality of your Netlify site - -**Usage** - -```bash -netlify addons:delete -``` - -**Arguments** - -- name - Add-on namespace - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `force` (*boolean*) - delete without prompting (useful for CI) -- `debug` (*boolean*) - Print debugging information - ---- -## `addons:list` - -List currently installed add-ons for site - -**Usage** - -```bash -netlify addons:list -``` - -**Flags** - -- `filter` (*string*) - For monorepos, specify the name of the application to run the command in -- `json` (*boolean*) - Output add-on data as JSON -- `debug` (*boolean*) - Print debugging information - ---- - - diff --git a/site/src/_app.js b/site/src/_app.js index 372a315f976..ea39201c6e8 100644 --- a/site/src/_app.js +++ b/site/src/_app.js @@ -37,7 +37,6 @@ const navOrder = [ 'index', 'getting-started', 'commands', - 'addons', 'api', 'blobs', 'build', @@ -65,7 +64,6 @@ const navOrder = [ const pageNames = { index: 'CLI Reference', 'getting-started': 'Getting Started', - addons: 'addons (deprecated)', } const sortRoutes = (routes) => diff --git a/site/src/register-addon-thanks.md b/site/src/register-addon-thanks.md deleted file mode 100644 index 970dffe59d4..00000000000 --- a/site/src/register-addon-thanks.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Thanks for the Addon Request! -hidden: true -hidePagination: true ---- - -# Thanks for reaching out! - -We will get back with you shortly about your Netlify addon request. diff --git a/site/src/register-addon.md b/site/src/register-addon.md deleted file mode 100644 index 703964fff7a..00000000000 --- a/site/src/register-addon.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Register a new Netlify Addon -description: Netlify Command line interface (CLI) documentation -hidden: true -hidePagination: true ---- - -# Netlify addons - -> ⚠️ The addons command is [deprecated](https://docs.netlify.com/platform/release-phases/#deprecated) and will become unavailable in a future update. - -A Netlify addon is a way for Netlify users to extend their sites. - -For example a user can provision additional functionality on their site by running: - -```bash -netlify addons:create your-addon-namespace -``` - -This would create a new instance of `your-addon-namespace` for that Netlify Site. - -**Some example of Netlify addons:** - -- Automatically inject error tracking into your app -- Provision a new database -- Setup `env` variables in Netlify's build context for users Automatically -- ...sky is the limit - -## Register Addon - -Do you have an addon idea that you'd like to create? Let us know - -
- -

-

- -
- -

-

-

- -
- -

-

-

- -
-