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
Signing the contributor's agreement does not grant anyone commit rights to the main
40
-
repository, but it does mean that we can accept your contributions, and you will get an
41
-
author credit if we do. Active contributors might be asked to join the core team, and
42
-
given the ability to merge pull requests.
43
-
44
-
[[code-of-conduct]]
45
-
== Code of Conduct
46
-
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/modules/ROOT/partials/code-of-conduct.adoc[code of
47
-
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
63
-
`@author` tag identifying you, and preferably at least a paragraph on what the class is
64
-
for.
65
-
* Add the ASF license header comment to all new `.java` files (copy from existing files
66
-
in the project)
67
-
* Add yourself as an `@author` to the .java files that you modify substantially (more
68
-
than cosmetic changes).
69
-
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
70
-
* A few unit tests would help a lot as well -- someone has to do it.
71
-
* If no-one else is using your branch, please rebase it against the current main (or
72
-
other target branch in the main project).
73
-
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
74
-
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
75
-
message (where XXXX is the issue number).
28
+
[[basic-compile-and-test]]
29
+
== Basic Compile and Test
76
30
77
-
[[checkstyle]]
78
-
== Checkstyle
31
+
To build the source you will need to install JDK {jdkversion}.
79
32
80
-
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:
33
+
Spring Cloud uses Maven for most build-related activities, and you
34
+
should be able to get off the ground quite quickly by cloning the
35
+
project you are interested in and typing
81
36
82
-
.spring-cloud-build-tools/
83
37
----
84
-
└── src
85
-
├── checkstyle
86
-
│ └── checkstyle-suppressions.xml <3>
87
-
└── main
88
-
└── resources
89
-
├── checkstyle-header.txt <2>
90
-
└── checkstyle.xml <1>
38
+
$ ./mvnw install
91
39
----
92
-
<1> Default Checkstyle rules
93
-
<2> File header setup
94
-
<3> Default suppression rules
95
-
96
-
[[checkstyle-configuration]]
97
-
=== Checkstyle configuration
98
40
99
-
Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins.
100
-
101
-
.pom.xml
41
+
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
42
+
in place of `./mvnw` in the examples below. If you do that you also
43
+
might need to add `-P spring` if your local Maven settings do not
44
+
contain repository declarations for spring pre-release artifacts.
45
+
46
+
NOTE: Be aware that you might need to increase the amount of memory
47
+
available to Maven by setting a `MAVEN_OPTS` environment variable with
48
+
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
49
+
the `.mvn` configuration, so if you find you have to do it to make a
50
+
build succeed, please raise a ticket to get the settings added to
51
+
source control.
52
+
53
+
The projects that require middleware (i.e. Redis) for testing generally
54
+
require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running.
55
+
56
+
[[documentation]]
57
+
== Documentation
58
+
59
+
The spring-cloud-build module has a "docs" profile, and if you switch
60
+
that on it will try to build asciidoc sources using https://docs.antora.org/antora/latest/[Antora] from
61
+
`modules/ROOT/`.
62
+
63
+
As part of that process it will look for a
64
+
`docs/src/main/asciidoc/README.adoc` and process it by loading all the includes, but not
65
+
parsing or rendering it, just copying it to `${main.basedir}`
66
+
(defaults to `$\{basedir}`, i.e. the root of the project). If there are
67
+
any changes in the README it will then show up after a Maven build as
68
+
a modified file in the correct place. Just commit it and push the change.
69
+
70
+
[[working-with-the-code]]
71
+
== Working with the code
72
+
If you don't have an IDE preference we would recommend that you use
73
+
https://www.springsource.com/developer/sts[Spring Tools Suite] or
74
+
https://eclipse.org[Eclipse] when working with the code. We use the
75
+
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
76
+
should also work without issue as long as they use Maven 3.3.3 or better.
77
+
78
+
[[activate-the-spring-maven-profile]]
79
+
=== Activate the Spring Maven profile
80
+
Spring Cloud projects require the 'spring' Maven profile to be activated to resolve
81
+
the spring milestone and snapshot repositories. Use your preferred IDE to set this
82
+
profile to be active, or you may experience build errors.
83
+
84
+
[[importing-into-eclipse-with-m2eclipse]]
85
+
=== Importing into eclipse with m2eclipse
86
+
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
87
+
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
88
+
marketplace".
89
+
90
+
NOTE: Older versions of m2e do not support Maven 3.3, so once the
91
+
projects are imported into Eclipse you will also need to tell
92
+
m2eclipse to use the right profile for the projects. If you
93
+
see many different errors related to the POMs in the projects, check
94
+
that you have an up to date installation. If you can't upgrade m2e,
95
+
add the "spring" profile to your `settings.xml`. Alternatively you can
96
+
copy the repository settings from the "spring" profile of the parent
97
+
pom into your `settings.xml`.
98
+
99
+
[[importing-into-eclipse-without-m2eclipse]]
100
+
=== Importing into eclipse without m2eclipse
101
+
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
137
-
<5> Add checkstyle plugin to your build and reporting phases
138
-
139
-
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.
167
-
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/main/spring-cloud-build-tools[Spring Cloud Build] project.
168
-
169
-
.spring-cloud-build-tools/
170
-
----
171
-
└── src
172
-
├── checkstyle
173
-
│ └── checkstyle-suppressions.xml <3>
174
-
└── main
175
-
└── resources
176
-
├── checkstyle-header.txt <2>
177
-
├── checkstyle.xml <1>
178
-
└── intellij
179
-
├── Intellij_Project_Defaults.xml <4>
180
-
└── Intellij_Spring_Boot_Java_Conventions.xml <5>
181
-
----
182
-
<1> Default Checkstyle rules
183
-
<2> File header setup
184
-
<3> Default suppression rules
185
-
<4> Project defaults for Intellij that apply most of Checkstyle rules
186
-
<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.
199
-
200
-
.Checkstyle
201
-
202
-
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/main/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
207
-
208
-
- `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/main/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
209
-
- `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/main/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
210
-
- `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`.
211
-
212
-
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
213
-
214
-
[[duplicate-finder]]
215
-
== Duplicate Finder
216
-
217
-
Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath.
218
-
219
-
[[duplicate-finder-configuration]]
220
-
=== Duplicate Finder configuration
221
-
222
-
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].
238
-
239
-
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.
240
-
241
-
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