diff --git a/multi/multi__contributing.html b/multi/multi__contributing.html index 88129cb7..019fc228 100644 --- a/multi/multi__contributing.html +++ b/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   
    12. Building Home 
    \ No newline at end of file +message (where XXXX is the issue number).

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

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

    13.5 IDE setup

    13.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 13.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 13.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   
    12. Building Home 
    \ No newline at end of file diff --git a/multi/multi_spring-cloud-kubernetes.html b/multi/multi_spring-cloud-kubernetes.html index 0c8284d1..31bac945 100644 --- a/multi/multi_spring-cloud-kubernetes.html +++ b/multi/multi_spring-cloud-kubernetes.html @@ -1,3 +1,3 @@ - Spring Cloud Kubernetes
    Spring Cloud Kubernetes
       Next

    Spring Cloud Kubernetes

    Table of Contents

    1. Why do you need Spring Cloud Kubernetes?
    2. DiscoveryClient for Kubernetes
    3. Kubernetes native service discovery
    4. Kubernetes PropertySource implementations
    4.1. ConfigMap PropertySource
    4.2. Secrets PropertySource
    4.3. PropertySource Reload
    5. Ribbon discovery in Kubernetes
    6. Kubernetes Ecosystem Awareness
    6.1. Kubernetes Profile Autoconfiguration
    6.2. Istio Awareness
    7. Pod Health Indicator
    8. Leader Election
    9. Security Configurations inside Kubernetes
    9.1. Namespace
    9.2. Service Account
    10. Examples
    11. Other Resources
    12. Building
    12.1. Basic Compile and Test
    12.2. Documentation
    12.3. Working with the code
    12.3.1. Importing into eclipse with m2eclipse
    12.3.2. Importing into eclipse without m2eclipse
    13. Contributing
    13.1. Sign the Contributor License Agreement
    13.2. Code of Conduct
    13.3. Code Conventions and Housekeeping
       Next
       1. Why do you need Spring Cloud Kubernetes?
    \ No newline at end of file + Spring Cloud Kubernetes
    Spring Cloud Kubernetes
       Next

    Spring Cloud Kubernetes

    Table of Contents

    1. Why do you need Spring Cloud Kubernetes?
    2. DiscoveryClient for Kubernetes
    3. Kubernetes native service discovery
    4. Kubernetes PropertySource implementations
    4.1. ConfigMap PropertySource
    4.2. Secrets PropertySource
    4.3. PropertySource Reload
    5. Ribbon discovery in Kubernetes
    6. Kubernetes Ecosystem Awareness
    6.1. Kubernetes Profile Autoconfiguration
    6.2. Istio Awareness
    7. Pod Health Indicator
    8. Leader Election
    9. Security Configurations inside Kubernetes
    9.1. Namespace
    9.2. Service Account
    10. Examples
    11. Other Resources
    12. Building
    12.1. Basic Compile and Test
    12.2. Documentation
    12.3. Working with the code
    12.3.1. Importing into eclipse with m2eclipse
    12.3.2. Importing into eclipse without m2eclipse
    13. Contributing
    13.1. Sign the Contributor License Agreement
    13.2. Code of Conduct
    13.3. Code Conventions and Housekeeping
    13.4. Checkstyle
    13.4.1. Checkstyle configuration
    13.5. IDE setup
    13.5.1. Intellij IDEA
       Next
       1. Why do you need Spring Cloud Kubernetes?
    \ No newline at end of file diff --git a/single/spring-cloud-kubernetes.html b/single/spring-cloud-kubernetes.html index 05643931..812839d8 100644 --- a/single/spring-cloud-kubernetes.html +++ b/single/spring-cloud-kubernetes.html @@ -1,6 +1,6 @@ - Spring Cloud Kubernetes

    Spring Cloud Kubernetes

    Table of Contents

    1. Why do you need Spring Cloud Kubernetes?
    2. DiscoveryClient for Kubernetes
    3. Kubernetes native service discovery
    4. Kubernetes PropertySource implementations
    4.1. ConfigMap PropertySource
    4.2. Secrets PropertySource
    4.3. PropertySource Reload
    5. Ribbon discovery in Kubernetes
    6. Kubernetes Ecosystem Awareness
    6.1. Kubernetes Profile Autoconfiguration
    6.2. Istio Awareness
    7. Pod Health Indicator
    8. Leader Election
    9. Security Configurations inside Kubernetes
    9.1. Namespace
    9.2. Service Account
    10. Examples
    11. Other Resources
    12. Building
    12.1. Basic Compile and Test
    12.2. Documentation
    12.3. Working with the code
    12.3.1. Importing into eclipse with m2eclipse
    12.3.2. Importing into eclipse without m2eclipse
    13. Contributing
    13.1. Sign the Contributor License Agreement
    13.2. Code of Conduct
    13.3. Code Conventions and Housekeeping

    1. Why do you need Spring Cloud Kubernetes?

    Spring Cloud Kubernetes provide Spring Cloud common interfaces implementations to consume Kubernetes native services. + Spring Cloud Kubernetes

    Spring Cloud Kubernetes

    Table of Contents

    1. Why do you need Spring Cloud Kubernetes?
    2. DiscoveryClient for Kubernetes
    3. Kubernetes native service discovery
    4. Kubernetes PropertySource implementations
    4.1. ConfigMap PropertySource
    4.2. Secrets PropertySource
    4.3. PropertySource Reload
    5. Ribbon discovery in Kubernetes
    6. Kubernetes Ecosystem Awareness
    6.1. Kubernetes Profile Autoconfiguration
    6.2. Istio Awareness
    7. Pod Health Indicator
    8. Leader Election
    9. Security Configurations inside Kubernetes
    9.1. Namespace
    9.2. Service Account
    10. Examples
    11. Other Resources
    12. Building
    12.1. Basic Compile and Test
    12.2. Documentation
    12.3. Working with the code
    12.3.1. Importing into eclipse with m2eclipse
    12.3.2. Importing into eclipse without m2eclipse
    13. Contributing
    13.1. Sign the Contributor License Agreement
    13.2. Code of Conduct
    13.3. Code Conventions and Housekeeping
    13.4. Checkstyle
    13.4.1. Checkstyle configuration
    13.5. IDE setup
    13.5.1. Intellij IDEA

    1. Why do you need Spring Cloud Kubernetes?

    Spring Cloud Kubernetes provide Spring Cloud common interfaces implementations to consume Kubernetes native services. The main objective of the projects provided in this repository is to facilitate the integration of Spring Cloud/Spring Boot applications running inside Kubernetes.

    2. DiscoveryClient for Kubernetes

    This project provides an implementation of Discovery Client for Kubernetes. This allows you to query Kubernetes endpoints (see services) by name. @@ -335,4 +335,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).
    • \ No newline at end of file +message (where XXXX is the issue number).

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

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

    13.5 IDE setup

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

    \ No newline at end of file diff --git a/spring-cloud-kubernetes.xml b/spring-cloud-kubernetes.xml index cfa55a5f..618fc5d4 100644 --- a/spring-cloud-kubernetes.xml +++ b/spring-cloud-kubernetes.xml @@ -846,5 +846,190 @@ 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. + +
    +
    \ No newline at end of file