diff --git a/README.md b/README.md index 72a9973d44e..2804326fba8 100644 --- a/README.md +++ b/README.md @@ -395,10 +395,10 @@ openapi-generator version ``` -Or install a particular OpenAPI Generator version (e.g. v4.1.2): +Or install a particular OpenAPI Generator version (e.g. v4.2.2): ```sh -npm install @openapitools/openapi-generator-cli@cli-4.1.2 -g +npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g ``` Or install it as dev-dependency: diff --git a/bin/utils/release/release_version_update_docs.sh b/bin/utils/release/release_version_update_docs.sh index 9a47f86bbf0..cfd66070e95 100755 --- a/bin/utils/release/release_version_update_docs.sh +++ b/bin/utils/release/release_version_update_docs.sh @@ -105,6 +105,8 @@ declare -a xml_files=( "${root}/modules/openapi-generator-maven-plugin/README.md" "${root}/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md" "${root}/README.md" + "${root}/docs/installation.md" + "${root}/website/pages/en/index.js" ) declare -a commented_files=( diff --git a/docs/installation.md b/docs/installation.md index 16cc1005f08..60105c9a9bc 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -20,11 +20,11 @@ npm install @openapitools/openapi-generator-cli -g ``` To install a specific version of the tool, pass the version during installation: - + ```bash -npm install @openapitools/openapi-generator-cli@cli-3.3.4 -g +npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g ``` - + To install the tool as a dev dependency in your current project: ```bash @@ -77,21 +77,23 @@ docker run --rm \ > **Platform(s)**: Linux, macOS, Windows + If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum): -JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar` +JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar` For **Mac/Linux** users: ```bash -wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar -O openapi-generator-cli.jar +wget https//repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar -O openapi-generator-cli.jar ``` For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g. ``` -Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar +Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar ``` + After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage. diff --git a/website/pages/en/index.js b/website/pages/en/index.js index 9111b5efcd2..698cec53814 100755 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -179,17 +179,18 @@ class Index extends React.Component { const tryNpmContents = stripMargin` | The [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) is cross-platform wrapper around the .jar artifact. | **Install** globally, exposing the CLI on the command line: - | + | | \`\`\`bash | # install the latest version of "openapi-generator-cli" | npm install @openapitools/openapi-generator-cli -g | | # install a specific version of "openapi-generator-cli" - | npm install @openapitools/openapi-generator-cli@cli-3.0.0 -g + | npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g | | # Or install it as dev-dependency in your node.js projects | npm install @openapitools/openapi-generator-cli -D | \`\`\` + | | | Then, **generate** a ruby client from a valid [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml) doc: | \`\`\`bash