diff --git a/2.0.x/images/callouts/1.png b/2.0.x/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/2.0.x/images/callouts/1.png differ diff --git a/2.0.x/images/callouts/2.png b/2.0.x/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/2.0.x/images/callouts/2.png differ diff --git a/2.0.x/images/callouts/3.png b/2.0.x/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/2.0.x/images/callouts/3.png differ diff --git a/2.0.x/index.html b/2.0.x/index.html index 2bffe127..dad58822 100644 --- a/2.0.x/index.html +++ b/2.0.x/index.html @@ -90,7 +90,7 @@ $(addBlockSwitches);
-

2.0.0.BUILD-SNAPSHOT

+

2.0.5.BUILD-SNAPSHOT

diff --git a/2.0.x/multi/images/callouts/1.png b/2.0.x/multi/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/2.0.x/multi/images/callouts/1.png differ diff --git a/2.0.x/multi/images/callouts/2.png b/2.0.x/multi/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/2.0.x/multi/images/callouts/2.png differ diff --git a/2.0.x/multi/images/callouts/3.png b/2.0.x/multi/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/2.0.x/multi/images/callouts/3.png differ diff --git a/2.0.x/multi/multi__contributing.html b/2.0.x/multi/multi__contributing.html index c9db9932..39dc131f 100644 --- a/2.0.x/multi/multi__contributing.html +++ b/2.0.x/multi/multi__contributing.html @@ -25,4 +25,63 @@ in the project)
  • Add yourself as an Add some Javadocs and, if you change the namespace, some XSD doc elements.
  • A few unit tests would help a lot as well — someone has to do it.
  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
  • When writing a commit message please follow 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).
    • Prev   Next
    1. Building and Deploying Home 3. Reusing the documentation
    \ No newline at end of file +message (where XXXX is the issue number).

    2.4 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 1
+    └── main
+        └── resources
+            ├── checkstyle-header.txt 2
+            └── checkstyle.xml 3

    +

    3

    Default Checkstyle rules

    2

    File header setup

    1

    Default suppression rules

    2.4.1 Checkstyle configuration

    Checkstyle rules are disabled by default. To add checkstyle to your project just define the following properties and plugins.

    pom.xml.  +

    <properties>
+<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> 1
+        <maven-checkstyle-plugin.failsOnViolation>true
+        </maven-checkstyle-plugin.failsOnViolation> 2
+        <maven-checkstyle-plugin.includeTestSourceDirectory>true
+        </maven-checkstyle-plugin.includeTestSourceDirectory> 3
+</properties>
+
+<build>
+        <plugins>
+            <plugin> 4
+                <groupId>io.spring.javaformat</groupId>
+                <artifactId>spring-javaformat-maven-plugin</artifactId>
+            </plugin>
+            <plugin> 5
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+            </plugin>
+        </plugins>
+
+    <reporting>
+        <plugins>
+            <plugin> 6
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </reporting>
+</build>

    +

    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 6

    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.  +

    <?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+		"-//Puppy Crawl//DTD Suppressions 1.1//EN"
+		"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+<suppressions>
+	<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
+	<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
+</suppressions>

    +

    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:

    $ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
+$ touch .springformat

    2.5 IDE setup

    2.5.1 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 1
+    └── main
+        └── resources
+            ├── checkstyle-header.txt 2
+            ├── checkstyle.xml 3
+            └── intellij
+                ├── Intellij_Project_Defaults.xml 4
+                └── Intellij_Spring_Boot_Java_Conventions.xml 5

    +

    3

    Default Checkstyle rules

    2

    File header setup

    1

    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

    Figure 2.1. Code style

    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.

    Figure 2.2. Inspection profiles

    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

    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:

    [Important]Important

    Remember to set the Scan Scope to All sources since we apply checkstyle rules for production and test sources.

    Prev   Next
    1. Building and Deploying Home 3. Reusing the documentation
    \ No newline at end of file diff --git a/2.0.x/multi/multi__reusing_the_documentation.html b/2.0.x/multi/multi__reusing_the_documentation.html index c367a89c..16ed8d46 100644 --- a/2.0.x/multi/multi__reusing_the_documentation.html +++ b/2.0.x/multi/multi__reusing_the_documentation.html @@ -10,22 +10,22 @@ approach of generating documentation just add these plugins to your <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-dependency-plugin</artifactId> 1 + <artifactId>maven-dependency-plugin</artifactId> 1 </plugin> <plugin> <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> 2 + <artifactId>asciidoctor-maven-plugin</artifactId> 2 </plugin> <plugin> <groupId>com.agilejava.docbkx</groupId> - <artifactId>docbkx-maven-plugin</artifactId> 3 + <artifactId>docbkx-maven-plugin</artifactId> 3 </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> 4 + <artifactId>maven-antrun-plugin</artifactId> 4 <inherited>false</inherited> </plugin> </plugins> </build> </profile> - </profiles>

    1

    This plugin downloads and unpacks the resources of the spring-cloud-build-docs module

    2

    This plugin is required to parse the Asciidoctor documentation

    3

    This plugin converts the Asciidoctor documentation into single and multi page docs

    4

    This plugin is required to copy resources into proper final destinations and to generate main README.adoc

    [Important]Important

    The order of plugin declaration is important!

    Prev   
    2. Contributing Home 
    \ No newline at end of file + </profiles>

    1

    This plugin downloads and unpacks the resources of the spring-cloud-build-docs module

    2

    This plugin is required to parse the Asciidoctor documentation

    3

    This plugin converts the Asciidoctor documentation into single and multi page docs

    4

    This plugin is required to copy resources into proper final destinations and to generate main README.adoc

    [Important]Important

    The order of plugin declaration is important!

    Prev   
    2. Contributing Home 
    \ No newline at end of file diff --git a/2.0.x/multi/multi_spring-cloud-build.html b/2.0.x/multi/multi_spring-cloud-build.html index 5d34a549..6341967e 100644 --- a/2.0.x/multi/multi_spring-cloud-build.html +++ b/2.0.x/multi/multi_spring-cloud-build.html @@ -1,3 +1,3 @@ - Spring Cloud Build
    Spring Cloud Build
       Next

    Spring Cloud Build

    Table of Contents

    1. Building and Deploying
    2. Contributing
    2.1. Sign the Contributor License Agreement
    2.2. Code of Conduct
    2.3. Code Conventions and Housekeeping
    3. Reusing the documentation
       Next
       
    \ No newline at end of file + Spring Cloud Build
    Spring Cloud Build
       Next

    Spring Cloud Build

    Table of Contents

    1. Building and Deploying
    2. Contributing
    2.1. Sign the Contributor License Agreement
    2.2. Code of Conduct
    2.3. Code Conventions and Housekeeping
    2.4. Checkstyle
    2.4.1. Checkstyle configuration
    2.5. IDE setup
    2.5.1. Intellij IDEA
    3. Reusing the documentation
       Next
       
    \ No newline at end of file diff --git a/2.0.x/single/images/callouts/1.png b/2.0.x/single/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/2.0.x/single/images/callouts/1.png differ diff --git a/2.0.x/single/images/callouts/2.png b/2.0.x/single/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/2.0.x/single/images/callouts/2.png differ diff --git a/2.0.x/single/images/callouts/3.png b/2.0.x/single/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/2.0.x/single/images/callouts/3.png differ diff --git a/2.0.x/single/spring-cloud-build.html b/2.0.x/single/spring-cloud-build.html index 6f117a7d..6cd1a7f2 100644 --- a/2.0.x/single/spring-cloud-build.html +++ b/2.0.x/single/spring-cloud-build.html @@ -1,6 +1,6 @@ - Spring Cloud Build

    Spring Cloud Build

    Table of Contents

    1. Building and Deploying
    2. Contributing
    2.1. Sign the Contributor License Agreement
    2.2. Code of Conduct
    2.3. Code Conventions and Housekeeping
    3. Reusing the documentation

    Spring Cloud Build is a common utility project for Spring Cloud + Spring Cloud Build

    Spring Cloud Build

    Table of Contents

    1. Building and Deploying
    2. Contributing
    2.1. Sign the Contributor License Agreement
    2.2. Code of Conduct
    2.3. Code Conventions and Housekeeping
    2.4. Checkstyle
    2.4.1. Checkstyle configuration
    2.5. IDE setup
    2.5.1. Intellij IDEA
    3. Reusing the documentation

    Spring Cloud Build is a common utility project for Spring Cloud to use for plugin and dependency management.

    1. Building and Deploying

    To install locally:

    $ mvn install -s .settings.xml

    and to deploy snapshots to repo.spring.io:

    $ mvn deploy -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local

    for a RELEASE build use

    $ mvn deploy -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-release-local

    and for jcenter use

    $ mvn deploy -DaltReleaseDeploymentRepository=bintray::default::https://api.bintray.com/maven/spring/jars/org.springframework.cloud:build

    and for Maven Central use

    $ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2

    (the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent).

    2. Contributing

    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 @@ -26,7 +26,66 @@ in the project)

  • Add yourself as an Add some Javadocs and, if you change the namespace, some XSD doc elements.
  • A few unit tests would help a lot as well — someone has to do it.
  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
  • When writing a commit message please follow 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).

    • 3. Reusing the documentation

    Spring Cloud Build publishes its spring-cloud-build-docs module that contains +message (where XXXX is the issue number).

    2.4 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 1
+    └── main
+        └── resources
+            ├── checkstyle-header.txt 2
+            └── checkstyle.xml 3

    +

    3

    Default Checkstyle rules

    2

    File header setup

    1

    Default suppression rules

    2.4.1 Checkstyle configuration

    Checkstyle rules are disabled by default. To add checkstyle to your project just define the following properties and plugins.

    pom.xml.  +

    <properties>
+<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> 1
+        <maven-checkstyle-plugin.failsOnViolation>true
+        </maven-checkstyle-plugin.failsOnViolation> 2
+        <maven-checkstyle-plugin.includeTestSourceDirectory>true
+        </maven-checkstyle-plugin.includeTestSourceDirectory> 3
+</properties>
+
+<build>
+        <plugins>
+            <plugin> 4
+                <groupId>io.spring.javaformat</groupId>
+                <artifactId>spring-javaformat-maven-plugin</artifactId>
+            </plugin>
+            <plugin> 5
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+            </plugin>
+        </plugins>
+
+    <reporting>
+        <plugins>
+            <plugin> 6
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </reporting>
+</build>

    +

    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 6

    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.  +

    <?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+		"-//Puppy Crawl//DTD Suppressions 1.1//EN"
+		"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+<suppressions>
+	<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
+	<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
+</suppressions>

    +

    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:

    $ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
+$ touch .springformat

    2.5 IDE setup

    2.5.1 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 1
+    └── main
+        └── resources
+            ├── checkstyle-header.txt 2
+            ├── checkstyle.xml 3
+            └── intellij
+                ├── Intellij_Project_Defaults.xml 4
+                └── Intellij_Spring_Boot_Java_Conventions.xml 5

    +

    3

    Default Checkstyle rules

    2

    File header setup

    1

    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

    Figure 2.1. Code style

    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.

    Figure 2.2. Inspection profiles

    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

    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:

    [Important]Important

    Remember to set the Scan Scope to All sources since we apply checkstyle rules for production and test sources.

    3. Reusing the documentation

    Spring Cloud Build publishes its spring-cloud-build-docs module that contains helpful scripts (e.g. README generation ruby script) and css, xslt and images for the Spring Cloud documentation. If you want to follow the same convention approach of generating documentation just add these plugins to your docs module

    <profiles>
@@ -36,22 +95,22 @@ approach of generating documentation just add these plugins to your <plugins>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-dependency-plugin</artifactId> 1
+						<artifactId>maven-dependency-plugin</artifactId> 1
 					</plugin>
 					<plugin>
 						<groupId>org.asciidoctor</groupId>
-						<artifactId>asciidoctor-maven-plugin</artifactId> 2
+						<artifactId>asciidoctor-maven-plugin</artifactId> 2
 					</plugin>
 					<plugin>
 						<groupId>com.agilejava.docbkx</groupId>
-						<artifactId>docbkx-maven-plugin</artifactId> 3
+						<artifactId>docbkx-maven-plugin</artifactId> 3
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-antrun-plugin</artifactId> 4
+						<artifactId>maven-antrun-plugin</artifactId> 4
 						<inherited>false</inherited>
 					</plugin>
 				</plugins>
 			</build>
 		</profile>
-	</profiles>

    1

    This plugin downloads and unpacks the resources of the spring-cloud-build-docs module

    2

    This plugin is required to parse the Asciidoctor documentation

    3

    This plugin converts the Asciidoctor documentation into single and multi page docs

    4

    This plugin is required to copy resources into proper final destinations and to generate main README.adoc

    [Important]Important

    The order of plugin declaration is important!

    \ No newline at end of file + </profiles>

    1

    This plugin downloads and unpacks the resources of the spring-cloud-build-docs module

    2

    This plugin is required to parse the Asciidoctor documentation

    3

    This plugin converts the Asciidoctor documentation into single and multi page docs

    4

    This plugin is required to copy resources into proper final destinations and to generate main README.adoc

    [Important]Important

    The order of plugin declaration is important!

    \ No newline at end of file diff --git a/2.0.x/spring-cloud-build.xml b/2.0.x/spring-cloud-build.xml index 48549f6a..ab2a12e8 100644 --- a/2.0.x/spring-cloud-build.xml +++ b/2.0.x/spring-cloud-build.xml @@ -4,7 +4,7 @@ Spring Cloud Build -2017-11-28 +2019-02-14 @@ -97,6 +97,191 @@ 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 +    └── main +    └── resources +    ├── checkstyle-header.txt +    └── checkstyle.xml + + + + +Default Checkstyle rules + + +File header setup + + +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 + +<properties> +<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> + <maven-checkstyle-plugin.failsOnViolation>true + </maven-checkstyle-plugin.failsOnViolation> + <maven-checkstyle-plugin.includeTestSourceDirectory>true + </maven-checkstyle-plugin.includeTestSourceDirectory> +</properties> + +<build> + <plugins> + <plugin> + <groupId>io.spring.javaformat</groupId> + <artifactId>spring-javaformat-maven-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + </plugin> + </plugins> + + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + </plugin> + </plugins> + </reporting> +</build> + + + + +Fails the build upon Checkstyle errors + + +Fails the build upon Checkstyle violations + + +Checkstyle analyzes also the test sources + + +Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules + + +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 + +<?xml version="1.0"?> +<!DOCTYPE suppressions PUBLIC + "-//Puppy Crawl//DTD Suppressions 1.1//EN" + "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd"> +<suppressions> + <suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/> + <suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/> +</suppressions> + + +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: +$ 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 +    └── main +    └── resources +    ├── checkstyle-header.txt +    ├── checkstyle.xml +    └── intellij +       ├── Intellij_Project_Defaults.xml +       └── Intellij_Spring_Boot_Java_Conventions.xml + + + + +Default Checkstyle rules + + +File header setup + + +Default suppression rules + + +Project defaults for Intellij that apply most of Checkstyle rules + + +Project style conventions for Intellij that apply most of Checkstyle rules + + +
    +Code style + + + + +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 + + + + +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 + + + + + + +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. + + + +Remember to set the Scan Scope to All sources since we apply checkstyle rules for production and test sources. + +
    +
    Reusing the documentation @@ -111,19 +296,19 @@ approach of generating documentation just add these plugins to your doc <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-dependency-plugin</artifactId> + <artifactId>maven-dependency-plugin</artifactId> </plugin> <plugin> <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> + <artifactId>asciidoctor-maven-plugin</artifactId> </plugin> <plugin> <groupId>com.agilejava.docbkx</groupId> - <artifactId>docbkx-maven-plugin</artifactId> + <artifactId>docbkx-maven-plugin</artifactId> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> + <artifactId>maven-antrun-plugin</artifactId> <inherited>false</inherited> </plugin> </plugins> @@ -131,16 +316,16 @@ approach of generating documentation just add these plugins to your doc </profile> </profiles> - + This plugin downloads and unpacks the resources of the spring-cloud-build-docs module - + This plugin is required to parse the Asciidoctor documentation - + This plugin converts the Asciidoctor documentation into single and multi page docs - + This plugin is required to copy resources into proper final destinations and to generate main README.adoc