You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
https://pivotal.io/platform-as-a-service/migrating-to-cloud-native-application-architectures-ebook[Cloud Native] is a style of application development that encourages easy adoption of best practices in the areas of continuous delivery and value-driven development.
14
+
A related discipline is that of building https://12factor.net/[12-factor Applications], in which development practices are aligned with delivery and operations goals -- for instance, by using declarative programming and management and monitoring.
15
+
Spring Cloud facilitates these styles of development in a number of specific ways.
16
+
The starting point is a set of features to which all components in a distributed system need easy access.
17
+
18
+
Many of those features are covered by https://projects.spring.io/spring-boot[Spring Boot], on which Spring Cloud builds. Some more features are delivered by Spring Cloud as two libraries: Spring Cloud Context and Spring Cloud Commons.
19
+
Spring Cloud Context provides utilities and special services for the `ApplicationContext` of a Spring Cloud application (bootstrap context, encryption, refresh scope, and environment endpoints). Spring Cloud Commons is a set of abstractions and common classes used in different Spring Cloud implementations (such Spring Cloud Consul).
20
+
21
+
If you get an exception due to "Illegal key size" and you use Sun's JDK, you need to install the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.
Signing the contributor's agreement does not grant anyone commit rights to the main
126
+
repository, but it does mean that we can accept your contributions, and you will get an
127
+
author credit if we do. Active contributors might be asked to join the core team, and
128
+
given the ability to merge pull requests.
129
+
130
+
=== Code of Conduct
131
+
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of
132
+
conduct]. By participating, you are expected to uphold this code. Please report
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
147
+
`@author` tag identifying you, and preferably at least a paragraph on what the class is
148
+
for.
149
+
* Add the ASF license header comment to all new `.java` files (copy from existing files
150
+
in the project)
151
+
* Add yourself as an `@author` to the .java files that you modify substantially (more
152
+
than cosmetic changes).
153
+
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
154
+
* A few unit tests would help a lot as well -- someone has to do it.
155
+
* If no-one else is using your branch, please rebase it against the current master (or
156
+
other target branch in the main project).
157
+
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
158
+
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
159
+
message (where XXXX is the issue number).
160
+
161
+
=== Checkstyle
162
+
163
+
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:
164
+
165
+
.spring-cloud-build-tools/
166
+
----
167
+
└── src
168
+
├── checkstyle
169
+
│ └── checkstyle-suppressions.xml <3>
170
+
└── main
171
+
└── resources
172
+
├── checkstyle-header.txt <2>
173
+
└── checkstyle.xml <1>
174
+
----
175
+
<1> Default Checkstyle rules
176
+
<2> File header setup
177
+
<3> Default suppression rules
178
+
179
+
==== Checkstyle configuration
180
+
181
+
Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins.
<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
219
+
<5> Add checkstyle plugin to your build and reporting phases
220
+
221
+
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:
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:
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
247
+
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project.
248
+
249
+
.spring-cloud-build-tools/
250
+
----
251
+
└── src
252
+
├── checkstyle
253
+
│ └── checkstyle-suppressions.xml <3>
254
+
└── main
255
+
└── resources
256
+
├── checkstyle-header.txt <2>
257
+
├── checkstyle.xml <1>
258
+
└── intellij
259
+
├── Intellij_Project_Defaults.xml <4>
260
+
└── Intellij_Spring_Boot_Java_Conventions.xml <5>
261
+
----
262
+
<1> Default Checkstyle rules
263
+
<2> File header setup
264
+
<3> Default suppression rules
265
+
<4> Project defaults for Intellij that apply most of Checkstyle rules
266
+
<5> Project style conventions for Intellij that apply most of Checkstyle rules
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.
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.
279
+
280
+
.Checkstyle
281
+
282
+
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
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:
287
+
288
+
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/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.
289
+
- `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.
290
+
- `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`.
291
+
292
+
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
293
+
294
+
=== Duplicate Finder
295
+
296
+
Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath.
297
+
298
+
==== Duplicate Finder configuration
299
+
300
+
Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`.
For other properties, we have set defaults as listed in the https://github.com/basepom/duplicate-finder-maven-plugin/wiki[plugin documentation].
316
+
317
+
You can easily override them but setting the value of the selected property prefixed with `duplicate-finder-maven-plugin`. For example, set `duplicate-finder-maven-plugin.skip` to `true` in order to skip duplicates check in your build.
318
+
319
+
If you need to add `ignoredClassPatterns` or `ignoredResourcePatterns` to your setup, make sure to add them in the plugin configuration section of your project:
0 commit comments