feat(command-lm): merge netlify-lm-plugin to CLI (#1489)

netlify · Feb 14, 2021 · d1c6da1 · d1c6da1
1 parent 9cabb4c
commit d1c6da1
Show file tree

Hide file tree

Showing 22 changed files with 1,881 additions and 103 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -35,8 +35,10 @@ jobs:
         env:
           # GitHub secrets are not available when running on PR from forks
           # We set a flag so we can skip tests that access Netlify API
-          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           IS_FORK: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true }}
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          # NETLIFY_TEST_GITHUB_TOKEN is used to avoid reaching GitHub API limits in exec-fetcher.js
+          NETLIFY_TEST_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Get test coverage flags
         id: test-coverage-flags
         run: |-

diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ See the [CLI command line reference](https://cli.netlify.com/commands/) to get s
   * [functions](#functions)
   * [init](#init)
   * [link](#link)
+  * [lm](#lm)
   * [login](#login)
   * [open](#open)
   * [sites](#sites)
@@ -138,6 +139,17 @@ Configure continuous deployment for a new or existing site
 
 Link a local repo or project folder to an existing site on Netlify
 
+### [lm](/docs/commands/lm.md)
+
+Handle Netlify Large Media operations
+
+| Subcommand | description  |
+|:--------------------------- |:-----|
+| [`lm:info`](/docs/commands/lm.md#lminfo) | Show large media requirements information.  |
+| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media.  |
+| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media.  |
+
+
 ### [login](/docs/commands/login.md)
 
 Login to your Netlify account

diff --git a/docs/README.md b/docs/README.md
@@ -102,6 +102,17 @@ Configure continuous deployment for a new or existing site
 
 Link a local repo or project folder to an existing site on Netlify
 
+### [lm](/docs/commands/lm.md)
+
+Handle Netlify Large Media operations
+
+| Subcommand | description  |
+|:--------------------------- |:-----|
+| [`lm:info`](/docs/commands/lm.md#lminfo) | Show large media requirements information.  |
+| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media.  |
+| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media.  |
+
+
 ### [login](/docs/commands/login.md)
 
 Login to your Netlify account

diff --git a/docs/commands/index.md b/docs/commands/index.md
@@ -88,6 +88,17 @@ Configure continuous deployment for a new or existing site
 
 Link a local repo or project folder to an existing site on Netlify
 
+### [lm](/docs/commands/lm.md)
+
+Handle Netlify Large Media operations
+
+| Subcommand | description  |
+|:--------------------------- |:-----|
+| [`lm:info`](/docs/commands/lm.md#lminfo) | Show large media requirements information.  |
+| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media.  |
+| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media.  |
+
+
 ### [login](/docs/commands/login.md)
 
 Login to your Netlify account

diff --git a/docs/commands/lm.md b/docs/commands/lm.md
@@ -0,0 +1,97 @@
+---
+title: Netlify CLI lm command
+---
+
+# `lm`
+
+## About
+
+<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
+Handle Netlify Large Media operations
+The lm command will help you manage large media for a site
+
+
+**Usage**
+
+```bash
+netlify lm
+```
+
+**Flags**
+
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
+| Subcommand | description  |
+|:--------------------------- |:-----|
+| [`lm:info`](/docs/commands/lm.md#lminfo) | Show large media requirements information.  |
+| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media.  |
+| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media.  |
+
+
+**Examples**
+
+```bash
+netlify lm:info
+netlify lm:install
+netlify lm:setup
+```
+
+---
+## `lm:info`
+
+Show large media requirements information.
+
+**Usage**
+
+```bash
+netlify lm:info
+```
+
+**Flags**
+
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
+---
+## `lm:install`
+
+Configures your computer to use Netlify Large Media.
+It installs the required credentials helper for Git,
+and configures your Git environment with the right credentials.
+
+**Usage**
+
+```bash
+netlify lm:install
+```
+
+**Flags**
+
+- `force` (*boolean*) - Force the credentials helper installation
+
+---
+## `lm:setup`
+
+Configures your site to use Netlify Large Media.
+It runs the install command if you have not installed the dependencies yet.
+
+**Usage**
+
+```bash
+netlify lm:setup
+```
+
+**Flags**
+
+- `skip-install` (*boolean*) - Skip the credentials helper installation check
+- `force-install` (*boolean*) - Force the credentials helper installation
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
+---
+
+<!-- AUTO-GENERATED-CONTENT:END -->