From e1fc964bcb641be795ea8ae6be334607374ee05b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 27 Aug 2024 13:09:19 +0000 Subject: [PATCH] Update moderne-cli reference to v3.18.8 --- releases/cli-releases.md | 2 +- .../moderne-cli/cli-reference.md | 179 ++++++++++++++++++ .../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 +- .../workshops/air-gapped-cli.md | 10 +- .../workshops/moderne-cli-exercise.md | 18 +- 7 files changed, 203 insertions(+), 24 deletions(-) diff --git a/releases/cli-releases.md b/releases/cli-releases.md index a47f6d8..d5df5e1 100644 --- a/releases/cli-releases.md +++ b/releases/cli-releases.md @@ -3,6 +3,6 @@ | Component | Current version | | --------------------- | --------------- | | CLI version (Stable) | 3.17.2 | -| CLI version (Staging) | 3.18.7 | +| CLI version (Staging) | 3.18.8 | * [Moderne CLI reference docs](../user-documentation/moderne-cli/cli-reference.md) diff --git a/user-documentation/moderne-cli/cli-reference.md b/user-documentation/moderne-cli/cli-reference.md index 89d651a..9ef99e7 100644 --- a/user-documentation/moderne-cli/cli-reference.md +++ b/user-documentation/moderne-cli/cli-reference.md @@ -141,12 +141,19 @@ * [**mod config recipes artifacts maven edit**](#mod-config-recipes-artifacts-maven-edit) * [**mod config recipes artifacts maven delete**](#mod-config-recipes-artifacts-maven-delete) * [**mod config recipes artifacts maven show**](#mod-config-recipes-artifacts-maven-show) +* [**mod config recipes artifacts nuget**](#mod-config-recipes-artifacts-nuget) +* [**mod config recipes artifacts nuget edit**](#mod-config-recipes-artifacts-nuget-edit) +* [**mod config recipes artifacts nuget delete**](#mod-config-recipes-artifacts-nuget-delete) +* [**mod config recipes artifacts nuget show**](#mod-config-recipes-artifacts-nuget-show) * [**mod config recipes export**](#mod-config-recipes-export) * [**mod config recipes export json**](#mod-config-recipes-export-json) * [**mod config recipes export csv**](#mod-config-recipes-export-csv) * [**mod config recipes jar**](#mod-config-recipes-jar) * [**mod config recipes jar install**](#mod-config-recipes-jar-install) * [**mod config recipes jar delete**](#mod-config-recipes-jar-delete) +* [**mod config recipes nupkg**](#mod-config-recipes-nupkg) +* [**mod config recipes nupkg install**](#mod-config-recipes-nupkg-install) +* [**mod config recipes nupkg delete**](#mod-config-recipes-nupkg-delete) * [**mod config recipes moderne**](#mod-config-recipes-moderne) * [**mod config recipes moderne install**](#mod-config-recipes-moderne-install) * [**mod config recipes moderne push**](#mod-config-recipes-moderne-push) @@ -3025,6 +3032,7 @@ mod config recipes moderne sync * `artifacts`: Configures artifact repositories to resolve recipes from. * `export`: Export the recipe catalog for study by different tools. * `jar`: Adds or updates an artifact that contains recipes that should be added to the recipe marketplace in the CLI. +* `nupkg`: Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI. * `moderne`: Configures which Moderne recipes should be installed and used in the local CLI marketplace. * `delete`: Clear the whole recipe marketplace. * `list`: List the artifacts that are contributing recipes to the marketplace. @@ -3051,6 +3059,7 @@ mod config recipes artifacts [subcommands] * `show`: Displays the recipe artifacts repository configuration. * `default-repositories`: (INCUBATING) Configure the availability of default repositories. * `maven`: Configures a Maven-formatted artifact repository that recipes will be resolved from. +* `nuget`: Configures a Nuget-formatted artifact repository that recipes will be resolved from. ## mod config recipes artifacts artifactory @@ -3297,6 +3306,91 @@ mod config recipes artifacts maven show +## mod config recipes artifacts nuget + +Configures a Nuget-formatted artifact repository that recipes will be resolved from. + + +All subsequent recipe installation commands will use this Nuget repository. + +### Usage + +``` +mod config recipes artifacts nuget [subcommands] +``` + + +### Subcommands + +* `edit`: Configures the repository that recipes will be resolved from. +* `delete`: Removes the Nuget artifact repository repository configuration. +* `show`: Displays the Nuget artifact repository repository configuration. + +## mod config recipes artifacts nuget edit + +Configures the repository that recipes will be resolved from. + + +All subsequent recipe installation commands will use this artifact repository. + +### Usage + +``` +mod config recipes artifacts nuget edit [parameters] +``` + +### Examples + +``` +mod config recipes nuget edit --user --password +``` + +### Parameters + +| Name | Description | +| ---- | ----------- | +| url | The URL of the artifact repository that recipes will be resolved from. | + +### Options + +| Name | Description | Example | +| ---- | ----------- | ---------- | +| --authorization | The authorization header value to use. | `Bearer XXXXX` | +| --password | The password to authenticate with. | | +| --skip-ssl | If this parameter is included, SSL verification will be skipped. | | +| --user | The user to authenticate with. | | + + +## mod config recipes artifacts nuget delete + +Removes the Nuget artifact repository repository configuration. + + + + +### Usage + +``` +mod config recipes artifacts nuget delete +``` + + + +## mod config recipes artifacts nuget show + +Displays the Nuget artifact repository repository configuration. + + + + +### Usage + +``` +mod config recipes artifacts nuget show +``` + + + ## mod config recipes export Export the recipe catalog for study by different tools. @@ -3443,6 +3537,91 @@ mod config recipes jar delete rewrite-java +## mod config recipes nupkg + +Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI. + + +The recipes defined by this package will then be available to run. + +### Usage + +``` +mod config recipes nupkg [subcommands] +``` + +### Examples + +``` +mod config recipes nupkg install rewrite.java:LATEST +``` + + +### Subcommands + +* `install`: Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI. +* `delete`: Removes a package supplying recipes to the marketplace. + +## mod config recipes nupkg install + +Adds or updates a package that contains recipes that should be added to the recipe marketplace in the CLI. + + +The recipes defined by this package will then be available to run. + +### Usage + +``` +mod config recipes nupkg install [parameters] +``` + +### Examples + +``` +mod config recipes nupkg install rewrite.java:LATEST +``` + +### Parameters + +| Name | Description | +| ---- | ----------- | +| PIV | The package id, and version of the package to install in the format packageId:version. The version may be a fixed version, LATEST, or RELEASE. +The dependency will be resolved from the package source defined in **mod config lsts artifacts** | + +### Options + +| Name | Description | +| ---- | ----------- | +| --repository-url, --repository | The repository URL that the package will be resolved from. | + + +## mod config recipes nupkg delete + +Removes a package supplying recipes to the marketplace. + + +The recipes defined by this package will then no longer be available to run. + +### Usage + +``` +mod config recipes nupkg delete [parameters] +``` + +### Examples + +``` +mod config recipes nupkg delete rewrite.java +``` + +### Parameters + +| Name | Description | +| ---- | ----------- | +| artifact | An package id. | + + + ## mod config recipes moderne Configures which Moderne recipes should be installed and used in the local CLI marketplace. diff --git a/user-documentation/moderne-cli/getting-started/cli-intro.md b/user-documentation/moderne-cli/getting-started/cli-intro.md index e3bfc59..e049d1a 100644 --- a/user-documentation/moderne-cli/getting-started/cli-intro.md +++ b/user-documentation/moderne-cli/getting-started/cli-intro.md @@ -62,7 +62,7 @@ If everything was configured correctly, you should be able to type `mod` into yo ```bash ➜ mod -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Usage: @@ -255,7 +255,7 @@ cd $HOME/workshop You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Listing repositories from Moderne @@ -338,7 +338,7 @@ mod build . You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -469,7 +469,7 @@ mod run . --recipe DependencyVulnerabilityCheck You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -586,7 +586,7 @@ mod study . --last-recipe-run --data-table VulnerabilityReport You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Found recipe run 20240716083055-NH4Xb @@ -696,7 +696,7 @@ mod run . --recipe CommonStaticAnalysis You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -784,7 +784,7 @@ mod git checkout . -b workshop-changes --last-recipe-run You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Found recipe run 20240717084152-vY22R diff --git a/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md b/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md index cf36bb7..7140b99 100644 --- a/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md +++ b/user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install.md @@ -51,7 +51,7 @@ If everything was configured correctly, you should be able to type `mod` into yo ```bash ➜ mod -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Usage: diff --git a/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md b/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md index ec39a2e..8499a64 100644 --- a/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md +++ b/user-documentation/moderne-cli/how-to-guides/jdk-selection-and-config.md @@ -31,7 +31,7 @@ mod config java jdk list ```shell ➜ moderne-cli git:(main) ✗ mod config java jdk list -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Listing available JDKs diff --git a/user-documentation/workshops/air-gapped-cli.md b/user-documentation/workshops/air-gapped-cli.md index f13ad2f..81c456e 100644 --- a/user-documentation/workshops/air-gapped-cli.md +++ b/user-documentation/workshops/air-gapped-cli.md @@ -162,7 +162,7 @@ Here is what the results look like if everything ran correctly: ```bash ➜ mod git clone csv ./spring-data repos.csv --filter=tree:0 -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Reading CSV file @@ -200,7 +200,7 @@ Notice that you didn't need to configure Maven or Gradle, select Java versions, ```bash ➜ mod build ./spring-data -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -255,7 +255,7 @@ To view the diff, you can command + click on the file (or ctrl + click if on Win ```bash ➜ mod run ./spring-data --recipe CommonStaticAnalysis -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -329,7 +329,7 @@ MOD SUCCEEDED in (2m 6s) ```bash ➜ mod run ./spring-data --recipe UpgradeToJava17 -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -422,7 +422,7 @@ You should see: ```bash ➜ mod study ./spring-data --last-recipe-run --data-table SourcesFileResults -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Found recipe run 20240430092847-434iK diff --git a/user-documentation/workshops/moderne-cli-exercise.md b/user-documentation/workshops/moderne-cli-exercise.md index af303ab..29b1793 100644 --- a/user-documentation/workshops/moderne-cli-exercise.md +++ b/user-documentation/workshops/moderne-cli-exercise.md @@ -23,7 +23,7 @@ After that, we'll provide some additional examples that show other capabilities ``` ➜ mod -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Usage: @@ -101,7 +101,7 @@ mod config recipes moderne install UpgradeSpringBoot_3_2 ```shell ➜ mod config recipes moderne install UpgradeSpringBoot_3_2 -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 [1] Migrate to Spring Boot 3.2 [2] Migrate to Spring Boot 3.1 @@ -190,7 +190,7 @@ mod build $HOME/workshop You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -244,7 +244,7 @@ You can preview the changes by command/ctrl clicking on the patch file generated ```bash ➜ ~ mod run $HOME/workshop --recipe UpgradeSpringBoot_3_2 -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -309,7 +309,7 @@ mod git clone moderne . "Default" You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Listing repositories from Moderne @@ -349,7 +349,7 @@ mod build . You should see output similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -468,7 +468,7 @@ mod run . --recipe UpgradeToJava17 You should see results similar to the following ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories @@ -555,7 +555,7 @@ mod study . --last-recipe-run --data-table SourcesFileResults You should see results similar to the following. ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 Found recipe run 20240429093354-reHx5 @@ -657,7 +657,7 @@ mod run . --recipe org.openrewrite.staticanalysis.CommonStaticAnalysis You should see results similar to: ```bash -Moderne CLI 3.18.7 +Moderne CLI 3.18.8 > Selecting repositories