From c4fb7baf97a47c9c037969f67ba806c8c941950e Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Fri, 28 Jun 2019 13:48:18 -0400 Subject: [PATCH] Update SNAPSHOT to 2.1.0.RELEASE --- README.adoc | 154 +++++++++++++++++- docs/pom.xml | 4 +- docs/src/main/asciidoc/install.adoc | 10 +- pom.xml | 8 +- spring-cloud-cli-integration-tests/pom.xml | 2 +- spring-cloud-cli/pom.xml | 2 +- .../SpringCloudBomAstTransformation.java | 2 +- spring-cloud-launcher/pom.xml | 4 +- .../spring-cloud-launcher-cli/pom.xml | 2 +- .../cloud/launcher/cli/LauncherCommand.java | 2 +- .../pom.xml | 2 +- .../spring-cloud-launcher-dataflow/pom.xml | 2 +- .../spring-cloud-launcher-deployer/pom.xml | 2 +- .../deployer/DeployerApplication.java | 2 +- .../spring-cloud-launcher-eureka/pom.xml | 2 +- .../spring-cloud-launcher-h2/pom.xml | 2 +- .../pom.xml | 2 +- .../spring-cloud-launcher-kafka/pom.xml | 2 +- .../spring-cloud-launcher-stubrunner/pom.xml | 2 +- 19 files changed, 173 insertions(+), 35 deletions(-) diff --git a/README.adoc b/README.adoc index f2f582a..bdba72d 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,8 @@ -// Do not edit this file (e.g. go instead to src/main/asciidoc) +//// +DO NOT EDIT THIS FILE. IT WAS GENERATED. +Manual changes to this file will be lost when it is generated again. +Edit the files in the src/main/asciidoc/ directory instead. +//// image:https://circleci.com/gh/spring-cloud/spring-cloud-cli.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-cli"] @@ -18,23 +22,23 @@ development time). To install, make sure you have https://github.com/spring-projects/spring-boot[Spring Boot CLI] -(1.5.2 or better): +(2.1.0 or better): $ spring version - Spring CLI v1.5.4.RELEASE + Spring CLI v2.1.0.RELEASE E.g. for SDKMan users ``` -$ sdk install springboot 1.5.4.RELEASE -$ sdk use springboot 1.5.4.RELEASE +$ sdk install springboot 2.1.6.RELEASE +$ sdk use springboot 2.1.6.RELEASE ``` and install the Spring Cloud plugin ``` $ mvn install -$ spring install org.springframework.cloud:spring-cloud-cli:1.4.1.BUILD-SNAPSHOT +$ spring install org.springframework.cloud:spring-cloud-cli:2.1.0.RELEASE ``` IMPORTANT: **Prerequisites:** to use the encryption and decryption features @@ -80,7 +84,7 @@ credentials and you already have those. The projects that require middleware generally include a `docker-compose.yml`, so consider using -https://compose.docker.io/[Docker Compose] to run the middeware servers +https://docs.docker.com/compose/[Docker Compose] to run the middeware servers in Docker containers. See the README in the https://github.com/spring-cloud-samples/scripts[scripts demo repository] for specific instructions about the common cases of mongo, @@ -136,6 +140,8 @@ from the `file` menu. == Contributing +:spring-cloud-build-branch: master + Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want @@ -179,4 +185,136 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). \ No newline at end of file + message (where XXXX is the issue number). + +=== Checkstyle + +Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: + +.spring-cloud-build-tools/ +---- +└── src +    ├── checkstyle +    │   └── checkstyle-suppressions.xml <3> +    └── main +    └── resources +    ├── checkstyle-header.txt <2> +    └── checkstyle.xml <1> +---- +<1> Default Checkstyle rules +<2> File header setup +<3> Default suppression rules + +==== Checkstyle configuration + +Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. + +.pom.xml +---- + +true <1> + true + <2> + true + <3> + + + + + <4> + io.spring.javaformat + spring-javaformat-maven-plugin + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + +---- +<1> Fails the build upon Checkstyle errors +<2> Fails the build upon Checkstyle violations +<3> Checkstyle analyzes also the test sources +<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules +<5> Add checkstyle plugin to your build and reporting phases + +If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example: + +.projectRoot/src/checkstyle/checkstyle-suppresions.xml +---- + + + + + + +---- + +It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: + +```bash +$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig +$ touch .springformat +``` + +=== IDE setup + +==== Intellij IDEA + +In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. + +.spring-cloud-build-tools/ +---- +└── src +    ├── checkstyle +    │   └── checkstyle-suppressions.xml <3> +    └── main +    └── resources +    ├── checkstyle-header.txt <2> +    ├── checkstyle.xml <1> +    └── intellij +       ├── Intellij_Project_Defaults.xml <4> +       └── Intellij_Spring_Boot_Java_Conventions.xml <5> +---- +<1> Default Checkstyle rules +<2> File header setup +<3> Default suppression rules +<4> Project defaults for Intellij that apply most of Checkstyle rules +<5> Project style conventions for Intellij that apply most of Checkstyle rules + +.Code style + +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style] + +Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. + +.Inspection profiles + +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style] + +Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. + +.Checkstyle + +To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions + +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle] + +Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: + +- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. +- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. +- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. + +IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 2f6c242..5c08d82 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -7,7 +7,7 @@ org.springframework.cloud spring-cloud-cli-parent - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE pom Spring Cloud Cli Docs @@ -15,7 +15,7 @@ spring-cloud-cli ${basedir}/.. - 1.0.x,1.1.x,1.2.x,1.3.x,2.0.x + 1.3.x,2.0.x,2.1.x diff --git a/docs/src/main/asciidoc/install.adoc b/docs/src/main/asciidoc/install.adoc index 32002ac..a53f3e2 100644 --- a/docs/src/main/asciidoc/install.adoc +++ b/docs/src/main/asciidoc/install.adoc @@ -1,23 +1,23 @@ To install, make sure you have https://github.com/spring-projects/spring-boot[Spring Boot CLI] -(2.0.0 or better): +(2.1.0 or better): $ spring version - Spring CLI v2.1.0.M4 + Spring CLI v2.1.0.RELEASE E.g. for SDKMan users ``` -$ sdk install springboot 2.1.0.M4 -$ sdk use springboot 2.1.0.M4 +$ sdk install springboot 2.1.6.RELEASE +$ sdk use springboot 2.1.6.RELEASE ``` and install the Spring Cloud plugin ``` $ mvn install -$ spring install org.springframework.cloud:spring-cloud-cli:2.1.0.BUILD-SNAPSHOT +$ spring install org.springframework.cloud:spring-cloud-cli:2.1.0.RELEASE ``` IMPORTANT: **Prerequisites:** to use the encryption and decryption features diff --git a/pom.xml b/pom.xml index 642a166..1372495 100644 --- a/pom.xml +++ b/pom.xml @@ -5,11 +5,11 @@ 4.0.0 org.springframework.cloud spring-cloud-cli-parent - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE org.springframework.cloud spring-cloud-build - 2.1.0.BUILD-SNAPSHOT + 2.1.6.RELEASE pom @@ -29,8 +29,8 @@ cli spring-cloud-cli ${basedir}/.. - 2.1.6.BUILD-SNAPSHOT - Greenwich.BUILD-SNAPSHOT + 2.1.6.RELEASE + Greenwich.SR2 spring-cloud-launcher diff --git a/spring-cloud-cli-integration-tests/pom.xml b/spring-cloud-cli-integration-tests/pom.xml index 74234ae..8285ea4 100644 --- a/spring-cloud-cli-integration-tests/pom.xml +++ b/spring-cloud-cli-integration-tests/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-cli-parent - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-cli/pom.xml b/spring-cloud-cli/pom.xml index f2055f0..8c11c81 100644 --- a/spring-cloud-cli/pom.xml +++ b/spring-cloud-cli/pom.xml @@ -12,7 +12,7 @@ org.springframework.cloud spring-cloud-cli-parent - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-cli/src/main/java/org/springframework/cloud/cli/compiler/SpringCloudBomAstTransformation.java b/spring-cloud-cli/src/main/java/org/springframework/cloud/cli/compiler/SpringCloudBomAstTransformation.java index 8612403..f6094b7 100644 --- a/spring-cloud-cli/src/main/java/org/springframework/cloud/cli/compiler/SpringCloudBomAstTransformation.java +++ b/spring-cloud-cli/src/main/java/org/springframework/cloud/cli/compiler/SpringCloudBomAstTransformation.java @@ -28,7 +28,7 @@ import org.springframework.boot.cli.compiler.GenericBomAstTransformation; @GroovyASTTransformation(phase = CompilePhase.CONVERSION) public class SpringCloudBomAstTransformation extends GenericBomAstTransformation { - private static final String SPRING_CLOUD_VERSION = "Greenwich.BUILD-SNAPSHOT"; + private static final String SPRING_CLOUD_VERSION = "Greenwich.SR2"; @Override protected String getBomModule() { diff --git a/spring-cloud-launcher/pom.xml b/spring-cloud-launcher/pom.xml index 6c2c741..c7eabfa 100644 --- a/spring-cloud-launcher/pom.xml +++ b/spring-cloud-launcher/pom.xml @@ -5,7 +5,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE pom spring-cloud-launcher @@ -14,7 +14,7 @@ org.springframework.cloud spring-cloud-cli-parent - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-cli/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-cli/pom.xml index f13ef2f..6c828ae 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-cli/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-cli/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-cli/src/main/java/org/springframework/cloud/launcher/cli/LauncherCommand.java b/spring-cloud-launcher/spring-cloud-launcher-cli/src/main/java/org/springframework/cloud/launcher/cli/LauncherCommand.java index 0a2227c..be4c048 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-cli/src/main/java/org/springframework/cloud/launcher/cli/LauncherCommand.java +++ b/spring-cloud-launcher/spring-cloud-launcher-cli/src/main/java/org/springframework/cloud/launcher/cli/LauncherCommand.java @@ -51,7 +51,7 @@ public class LauncherCommand extends OptionParsingCommand { public static final Log log = LogFactory.getLog(LauncherCommand.class); - private static final String DEFAULT_VERSION = "2.1.0.BUILD-SNAPSHOT"; + private static final String DEFAULT_VERSION = "2.1.0.RELEASE"; private static final Collection EXAMPLES = new ArrayList<>(); diff --git a/spring-cloud-launcher/spring-cloud-launcher-configserver/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-configserver/pom.xml index 2016efc..60078da 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-configserver/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-configserver/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-dataflow/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-dataflow/pom.xml index 4aeabe2..3d8bb38 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-dataflow/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-dataflow/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-deployer/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-deployer/pom.xml index 95c673f..d91fdbe 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-deployer/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-deployer/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/java/org/springframework/cloud/launcher/deployer/DeployerApplication.java b/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/java/org/springframework/cloud/launcher/deployer/DeployerApplication.java index 9994108..9dc9dc7 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/java/org/springframework/cloud/launcher/deployer/DeployerApplication.java +++ b/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/java/org/springframework/cloud/launcher/deployer/DeployerApplication.java @@ -42,7 +42,7 @@ public class DeployerApplication { private static final Logger logger = LoggerFactory .getLogger(DeployerApplication.class); - private static final String DEFAULT_VERSION = "2.1.0.BUILD-SNAPSHOT"; + private static final String DEFAULT_VERSION = "2.1.0.RELEASE"; private String[] args; diff --git a/spring-cloud-launcher/spring-cloud-launcher-eureka/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-eureka/pom.xml index 1e027c3..ebf73e7 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-eureka/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-eureka/pom.xml @@ -14,7 +14,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-h2/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-h2/pom.xml index ee65764..b6a3c77 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-h2/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-h2/pom.xml @@ -14,7 +14,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-hystrixdashboard/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-hystrixdashboard/pom.xml index cb722a3..8059530 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-hystrixdashboard/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-hystrixdashboard/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-kafka/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-kafka/pom.xml index a1ae821..1a757d6 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-kafka/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-kafka/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE diff --git a/spring-cloud-launcher/spring-cloud-launcher-stubrunner/pom.xml b/spring-cloud-launcher/spring-cloud-launcher-stubrunner/pom.xml index bb8ca2c..3fd5a5f 100644 --- a/spring-cloud-launcher/spring-cloud-launcher-stubrunner/pom.xml +++ b/spring-cloud-launcher/spring-cloud-launcher-stubrunner/pom.xml @@ -13,7 +13,7 @@ org.springframework.cloud spring-cloud-launcher - 2.1.0.BUILD-SNAPSHOT + 2.1.0.RELEASE