From 423e32f4584f413e03460d2617d4724efff24168 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Thu, 7 Feb 2019 18:03:38 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__building_and_deploying.html | 2 +- multi/multi__contributing.html | 69 ++++- multi/multi__reusing_the_documentation.html | 10 +- multi/multi_spring-cloud-build.html | 2 +- single/spring-cloud-build.html | 84 +++--- spring-cloud-build.xml | 304 ++++++++++++-------- 6 files changed, 308 insertions(+), 163 deletions(-) diff --git a/multi/multi__building_and_deploying.html b/multi/multi__building_and_deploying.html index 0053df03..f8fea600 100644 --- a/multi/multi__building_and_deploying.html +++ b/multi/multi__building_and_deploying.html @@ -1,3 +1,3 @@ - 1. Building and Deploying
1. Building and Deploying
Prev   Next

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

Prev   Next
 Home 2. Checkstyle
\ No newline at end of file + 1. Building and Deploying
1. Building and Deploying
Prev   Next

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

Prev   Next
 Home 2. Contributing
\ No newline at end of file diff --git a/multi/multi__contributing.html b/multi/multi__contributing.html index ef054ad4..880bd1d4 100644 --- a/multi/multi__contributing.html +++ b/multi/multi__contributing.html @@ -1,17 +1,17 @@ - 3. Contributing
3. Contributing
Prev   Next

3. Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license, + 2. Contributing

2. Contributing
Prev   Next

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 to contribute even something trivial please do not hesitate, but -follow the guidelines below.

3.1 Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the +follow the guidelines below.

2.1 Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and -given the ability to merge pull requests.

3.2 Code of Conduct

This project adheres to the Contributor Covenant code of +given the ability to merge pull requests.

2.2 Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report -unacceptable behavior to spring-code-of-conduct@pivotal.io.

3.3 Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be +unacceptable behavior to spring-code-of-conduct@pivotal.io.

2.3 Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the @@ -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
2. Checkstyle Home 4. 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/multi/multi__reusing_the_documentation.html b/multi/multi__reusing_the_documentation.html index 30da1414..1a5d256e 100644 --- a/multi/multi__reusing_the_documentation.html +++ b/multi/multi__reusing_the_documentation.html @@ -1,6 +1,6 @@ - 4. Reusing the documentation
4. Reusing the documentation
Prev   

4. Reusing the documentation

Spring Cloud Build publishes its spring-cloud-build-docs module that contains + 3. Reusing the documentation

3. Reusing the documentation
Prev   

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>
@@ -10,18 +10,18 @@ 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>org.apache.maven.plugins</groupId>
-						<artifactId>maven-antrun-plugin</artifactId> 3
+						<artifactId>maven-antrun-plugin</artifactId> 3
 						<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 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   
3. 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 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/multi/multi_spring-cloud-build.html b/multi/multi_spring-cloud-build.html index 94abc31e..eb9f50c1 100644 --- a/multi/multi_spring-cloud-build.html +++ b/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. Checkstyle
2.1. Checkstyle configuration
3. Contributing
3.1. Sign the Contributor License Agreement
3.2. Code of Conduct
3.3. Code Conventions and Housekeeping
4. 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/single/spring-cloud-build.html b/single/spring-cloud-build.html index f6884310..045eff18 100644 --- a/single/spring-cloud-build.html +++ b/single/spring-cloud-build.html @@ -1,18 +1,40 @@ - Spring Cloud Build

Spring Cloud Build

Table of Contents

1. Building and Deploying
2. Checkstyle
2.1. Checkstyle configuration
3. Contributing
3.1. Sign the Contributor License Agreement
3.2. Code of Conduct
3.3. Code Conventions and Housekeeping
4. 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. 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/.  + 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 +to contribute even something trivial please do not hesitate, but +follow the guidelines below.

2.1 Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the +Contributor License Agreement. +Signing the contributor’s agreement does not grant anyone commit rights to the main +repository, but it does mean that we can accept your contributions, and you will get an +author credit if we do. Active contributors might be asked to join the core team, and +given the ability to merge pull requests.

2.2 Code of Conduct

This project adheres to the Contributor Covenant code of +conduct. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io.

2.3 Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be +added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipse +you can import formatter settings using the +eclipse-code-formatter.xml file from the +Spring +Cloud Build project. If using IntelliJ, you can use the +Eclipse Code Formatter +Plugin to import the same file.
  • Make sure all new .java files to have a simple Javadoc class comment with at least an +@author tag identifying you, and preferably at least a paragraph on what the class is +for.
  • Add the ASF license header comment to all new .java files (copy from existing files +in the project)
  • Add yourself as an @author to the .java files that you modify substantially (more +than cosmetic changes).
  • 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).

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
-            └── 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

2.1 Checkstyle configuration

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

pom.xml.  +    └── 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
@@ -32,7 +54,6 @@ to use for plugin and dependency management.

-

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.

3. 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 -to contribute even something trivial please do not hesitate, but -follow the guidelines below.

3.1 Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the -Contributor License Agreement. -Signing the contributor’s agreement does not grant anyone commit rights to the main -repository, but it does mean that we can accept your contributions, and you will get an -author credit if we do. Active contributors might be asked to join the core team, and -given the ability to merge pull requests.

3.2 Code of Conduct

This project adheres to the Contributor Covenant code of -conduct. By participating, you are expected to uphold this code. Please report -unacceptable behavior to spring-code-of-conduct@pivotal.io.

3.3 Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be -added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipse -you can import formatter settings using the -eclipse-code-formatter.xml file from the -Spring -Cloud Build project. If using IntelliJ, you can use the -Eclipse Code Formatter -Plugin to import the same file.
  • Make sure all new .java files to have a simple Javadoc class comment with at least an -@author tag identifying you, and preferably at least a paragraph on what the class is -for.
  • Add the ASF license header comment to all new .java files (copy from existing files -in the project)
  • Add yourself as an @author to the .java files that you modify substantially (more -than cosmetic changes).
  • 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).

4. Reusing the documentation

Spring Cloud Build publishes its spring-cloud-build-docs module that contains +

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>
@@ -87,18 +95,18 @@ 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>org.apache.maven.plugins</groupId>
-						<artifactId>maven-antrun-plugin</artifactId> 3
+						<artifactId>maven-antrun-plugin</artifactId> 3
 						<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 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 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/spring-cloud-build.xml b/spring-cloud-build.xml index 30422ad3..e3a588ca 100644 --- a/spring-cloud-build.xml +++ b/spring-cloud-build.xml @@ -31,113 +31,6 @@ to use for plugin and dependency management. $ 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). - -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 -    └── 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 - - -
-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> - </build> - - <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. -
- Contributing Spring Cloud is released under the non-restrictive Apache 2.0 license, @@ -204,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 @@ -218,15 +296,15 @@ 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>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> + <artifactId>maven-antrun-plugin</artifactId> <inherited>false</inherited> </plugin> </plugins> @@ -234,13 +312,13 @@ 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 is required to copy resources into proper final destinations and to generate main README.adoc