diff --git a/.gitignore b/.gitignore
index f86812da..b0bfd486 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,4 +14,5 @@ _site/
*.swp
*.log
.checkstyle
-.DS_Store
\ No newline at end of file
+.DS_Store
+.vscode/
\ No newline at end of file
diff --git a/README.adoc b/README.adoc
index 492db689..d77b15b9 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://travis-ci.org/spring-cloud/spring-cloud-zookeeper.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-zookeeper]
@@ -133,6 +137,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
@@ -176,4 +182,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 http://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 508e5b14..e082c016 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -6,7 +6,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
spring-cloud-zookeeper-docs
pom
@@ -27,23 +27,16 @@
maven-dependency-plugin
- org.asciidoctor
- asciidoctor-maven-plugin
- false
+ org.apache.maven.plugins
+ maven-resources-plugin
- com.agilejava.docbkx
- docbkx-maven-plugin
+ org.asciidoctor
+ asciidoctor-maven-plugin
org.apache.maven.plugins
maven-antrun-plugin
- false
-
-
- org.codehaus.mojo
- build-helper-maven-plugin
- false
diff --git a/pom.xml b/pom.xml
index 4d478bde..49e565d5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
pom
Spring Cloud Zookeeper
Spring Cloud Zookeeper
@@ -14,7 +14,7 @@
org.springframework.cloud
spring-cloud-build
- 2.1.3.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
@@ -175,11 +175,11 @@
- 2.1.3.BUILD-SNAPSHOT
- 2.1.1.BUILD-SNAPSHOT
- 2.1.1.BUILD-SNAPSHOT
- 2.1.1.BUILD-SNAPSHOT
- 2.1.1.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
diff --git a/spring-cloud-starter-zookeeper-all/pom.xml b/spring-cloud-starter-zookeeper-all/pom.xml
index a8fcd562..00694da3 100644
--- a/spring-cloud-starter-zookeeper-all/pom.xml
+++ b/spring-cloud-starter-zookeeper-all/pom.xml
@@ -5,7 +5,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
spring-cloud-starter-zookeeper-all
diff --git a/spring-cloud-starter-zookeeper-config/pom.xml b/spring-cloud-starter-zookeeper-config/pom.xml
index 03ac24ae..ebffd654 100644
--- a/spring-cloud-starter-zookeeper-config/pom.xml
+++ b/spring-cloud-starter-zookeeper-config/pom.xml
@@ -5,7 +5,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
spring-cloud-starter-zookeeper-config
diff --git a/spring-cloud-starter-zookeeper-discovery/pom.xml b/spring-cloud-starter-zookeeper-discovery/pom.xml
index d1575931..b9a40b9a 100644
--- a/spring-cloud-starter-zookeeper-discovery/pom.xml
+++ b/spring-cloud-starter-zookeeper-discovery/pom.xml
@@ -6,7 +6,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
spring-cloud-starter-zookeeper-discovery
diff --git a/spring-cloud-starter-zookeeper/pom.xml b/spring-cloud-starter-zookeeper/pom.xml
index d3a799aa..0aca94c4 100644
--- a/spring-cloud-starter-zookeeper/pom.xml
+++ b/spring-cloud-starter-zookeeper/pom.xml
@@ -5,7 +5,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
spring-cloud-starter-zookeeper
diff --git a/spring-cloud-zookeeper-config/pom.xml b/spring-cloud-zookeeper-config/pom.xml
index 5138c62f..698c7a5e 100644
--- a/spring-cloud-zookeeper-config/pom.xml
+++ b/spring-cloud-zookeeper-config/pom.xml
@@ -12,7 +12,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
diff --git a/spring-cloud-zookeeper-core/pom.xml b/spring-cloud-zookeeper-core/pom.xml
index 37392005..c2e577c8 100644
--- a/spring-cloud-zookeeper-core/pom.xml
+++ b/spring-cloud-zookeeper-core/pom.xml
@@ -12,7 +12,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
diff --git a/spring-cloud-zookeeper-dependencies/pom.xml b/spring-cloud-zookeeper-dependencies/pom.xml
index f736a433..daaf917f 100644
--- a/spring-cloud-zookeeper-dependencies/pom.xml
+++ b/spring-cloud-zookeeper-dependencies/pom.xml
@@ -5,11 +5,11 @@
spring-cloud-dependencies-parent
org.springframework.cloud
- 2.1.3.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
spring-cloud-zookeeper-dependencies
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
pom
spring-cloud-zookeeper-dependencies
Spring Cloud Zookeeper Dependencies
diff --git a/spring-cloud-zookeeper-discovery/pom.xml b/spring-cloud-zookeeper-discovery/pom.xml
index 0cc22b59..17d76e7a 100644
--- a/spring-cloud-zookeeper-discovery/pom.xml
+++ b/spring-cloud-zookeeper-discovery/pom.xml
@@ -12,7 +12,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..
diff --git a/spring-cloud-zookeeper-sample/pom.xml b/spring-cloud-zookeeper-sample/pom.xml
index 00d70493..1e5ba954 100644
--- a/spring-cloud-zookeeper-sample/pom.xml
+++ b/spring-cloud-zookeeper-sample/pom.xml
@@ -11,7 +11,7 @@
org.springframework.cloud
spring-cloud-zookeeper
- 2.1.2.BUILD-SNAPSHOT
+ 2.2.0.BUILD-SNAPSHOT
..