From 5fee27977f8f56a59375a570ae0cd5cc01d17f6e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 24 Jan 2025 20:51:18 +0000 Subject: [PATCH] Update moderne-cli reference to v3.31.0 --- docs/releases/cli-releases.md | 2 +- .../moderne-cli/cli-reference.md | 98 ++++++++++++++++++- .../moderne-cli/getting-started/cli-intro.md | 14 +-- .../how-to-guides/air-gapped-cli-install.md | 2 +- .../how-to-guides/jdk-selection-and-config.md | 2 +- 5 files changed, 107 insertions(+), 11 deletions(-) diff --git a/docs/releases/cli-releases.md b/docs/releases/cli-releases.md index 71c24e0f..035cfab5 100644 --- a/docs/releases/cli-releases.md +++ b/docs/releases/cli-releases.md @@ -3,7 +3,7 @@ | Component | Current version | | --------------------- | --------------- | | CLI version (Stable) | 3.26.2 | -| CLI version (Staging) | 3.30.0 | +| CLI version (Staging) | 3.31.0 | * [How to update to the latest version of the CLI](../user-documentation/moderne-cli/how-to-guides/cli-upgrade.md) * [Moderne CLI reference docs](../user-documentation/moderne-cli/cli-reference.md) diff --git a/docs/user-documentation/moderne-cli/cli-reference.md b/docs/user-documentation/moderne-cli/cli-reference.md index 97e83882..8c47316c 100644 --- a/docs/user-documentation/moderne-cli/cli-reference.md +++ b/docs/user-documentation/moderne-cli/cli-reference.md @@ -128,6 +128,11 @@ * [**mod config moderne show**](#mod-config-moderne-show) * [**mod config moderne organizations**](#mod-config-moderne-organizations) * [**mod config moderne organizations show**](#mod-config-moderne-organizations-show) +* [**mod config node**](#mod-config-node) +* [**mod config node installation**](#mod-config-node-installation) +* [**mod config node installation edit**](#mod-config-node-installation-edit) +* [**mod config node installation delete**](#mod-config-node-installation-delete) +* [**mod config node installation list**](#mod-config-node-installation-list) * [**mod config recipes**](#mod-config-recipes) * [**mod config recipes artifacts**](#mod-config-recipes-artifacts) * [**mod config recipes artifacts artifactory**](#mod-config-recipes-artifacts-artifactory) @@ -592,6 +597,7 @@ mod config moderne edit --api --token * `license`: Configure a license key. * `lsts`: Configures LSTs production and publishing. * `moderne`: Configures the connection to Moderne. Must be configured before you can install and run recipes. +* `node`: Configures Node options used for building LSTs and running recipes. * `recipes`: Configures the recipe marketplace available to the CLI. Must be configured before you can run recipes. * `run`: Configures recipe run behavior. * `scm`: Configures source code management. @@ -3058,6 +3064,96 @@ mod config moderne organizations show | --json | | +## mod config node + +Configures Node options used for building LSTs and running recipes. + + +Must be configured before you can run the commands that involve non-standard Node configurations. + +### Usage + +``` +mod config node [subcommands] +``` + + +### Subcommands + +* `installation`: Configures locations of Node that can be used by build tools. + +## mod config node installation + +Configures locations of Node that can be used by build tools. + + +Must be configured before you can run the build command if Node is installed in non-standard locations. + +### Usage + +``` +mod config node installation [subcommands] +``` + + +### Subcommands + +* `edit`: Configures locations of Node that can be used by build tools. +* `delete`: Removes the configured Node installations. The CLI will revert to using only detectable Node installations. +* `list`: Displays the detected and configured Node installations in the order in which they will be selected, constrained by versions detected from a particular repository. + +## mod config node installation edit + +Configures locations of Node that can be used by build tools. + + +Must be configured before you can run the build command if Node is installed in non-standard locations. + +### Usage + +``` +mod config node installation edit [parameters] +``` + +### Parameters + +| Name | Description | +| ---- | ----------- | +| nodeInstallations | The paths on disk where Node installations can be found. | + + + +## mod config node installation delete + +Removes the configured Node installations. The CLI will revert to using only detectable Node installations. + + +### Usage + +``` +mod config node installation delete +``` + + + +## mod config node installation list + +Displays the detected and configured Node installations in the order in which they will be selected, constrained by versions detected from a particular repository. + + +### Usage + +``` +mod config node installation list +``` + +### Options + +| Name | Description | +| ---- | ----------- | +| --named | Filter the list of Node installations to . | + + ## mod config recipes Configures the recipe marketplace available to the CLI. Must be configured before you can run recipes. @@ -4937,7 +5033,7 @@ mod git push /path/to/project -u origin feature-branch | --repository-branch | Restricts the command to only run against repositories that are currently on this branch. | `main` | | --repository-origin | Restricts the command to only run against repositories that have an origin that matches this.

Supports partial matches (e.g., if the origin is *git@github.com:foo/bar* - all of the following would match this: github.com:foo/bar, github.com, foo, and foo/bar). | `github.com` | | --repository-path | Restricts the command to only run against repositories that have a path (a combination of the organization/project and the repository name) that matches this.

Supports partial matches (e.g., if the repository is in the _foo_ organization and is called _bar_ - all of the following would match this: foo/bar, foo/.*, foo, and bar). | `openrewrite/rewrite` | -| --u, --set-upstream | For every branch that is up to date or successfully pushed, add upstream (tracking) reference. | | +| -u, --set-upstream | For every branch that is up to date or successfully pushed, add upstream (tracking) reference. | | ## mod git reset diff --git a/docs/user-documentation/moderne-cli/getting-started/cli-intro.md b/docs/user-documentation/moderne-cli/getting-started/cli-intro.md index b7e5b71e..c6dd6451 100644 --- a/docs/user-documentation/moderne-cli/getting-started/cli-intro.md +++ b/docs/user-documentation/moderne-cli/getting-started/cli-intro.md @@ -35,7 +35,7 @@ If everything was configured correctly, you should be able to type `mod` into yo ```bash ➜ mod -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 Usage: @@ -168,7 +168,7 @@ If you need to enter an SSH passphrase to clone repositories, please see our [SS You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 > Cloning organization from Moderne @@ -245,7 +245,7 @@ mod build . --download-only You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 > Selecting repositories @@ -441,7 +441,7 @@ mod run . --recipe DependencyVulnerabilityCheck --parallel 0 You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 > Selecting repositories @@ -559,7 +559,7 @@ mod study . --last-recipe-run --data-table VulnerabilityReport You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 Found recipe run 20250114092524-RN2dY @@ -660,7 +660,7 @@ mod run . --recipe CommonStaticAnalysis --parallel 0 You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 > Selecting repositories @@ -742,7 +742,7 @@ mod git checkout . -b workshop-changes --last-recipe-run You should see output similar to the following. ```bash -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 Found recipe run 20250114093829-TkzAc diff --git a/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md b/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md index c7100273..8abdeecb 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md @@ -57,7 +57,7 @@ If everything was configured correctly, you should be able to type `mod` into yo ```bash ➜ mod -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 Usage: diff --git a/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md b/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md index 2403170e..89843980 100644 --- a/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md +++ b/docs/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md @@ -31,7 +31,7 @@ mod config java jdk list ```bash ➜ moderne-cli git:(main) ✗ mod config java jdk list -Moderne CLI 3.30.0 +Moderne CLI 3.31.0 > Listing available JDKs