Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spring-cloud/spring-cloud-build

Common build concerns, shared plugin configuration, etc. for Spring Cloud modules
https://github.com/spring-cloud/spring-cloud-build

build java maven microservices spring spring-boot spring-cloud spring-cloud-core

Last synced: 4 days ago
JSON representation

Common build concerns, shared plugin configuration, etc. for Spring Cloud modules

Awesome Lists containing this project

README 

        
////

DO NOT EDIT THIS FILE. IT WAS GENERATED.

Manual changes to this file will be lost when it is generated again.

Edit the files in the src/main/asciidoc/ directory instead.

////



image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge.svg?branch=main&style=svg["Build",link="https://github.com/spring-cloud/spring-cloud-build/actions"]



Spring Cloud Build is a common utility project for Spring Cloud

to use for plugin and dependency management.



[[building-and-deploying]]

= 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/snapshot

----



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



[[contributing]]

= Contributing



:spring-cloud-build-branch: main



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 main. If you want

to contribute even something trivial please do not hesitate, but

follow the guidelines below.



[[sign-the-contributor-license-agreement]]

== Sign the Contributor License Agreement



Before we accept a non-trivial patch or pull request we will need you to sign the

https://cla.pivotal.io/sign/spring[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.



[[code-of-conduct]]

== Code of Conduct

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

conduct]. By participating, you  are expected to uphold this code. Please report

unacceptable behavior to [email protected].



[[code-conventions-and-housekeeping]]

== 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

  https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring

  Cloud Build] project. If using IntelliJ, you can use the

  https://plugins.jetbrains.com/plugin/6546[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 main (or

  other target branch in the main project).

* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[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).



[[checkstyle]]

== 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 <3>

    └── main

        └── resources

            ├── checkstyle-header.txt <2>

            └── checkstyle.xml <1>

----

<1> Default Checkstyle rules

<2> File header setup

<3> Default suppression rules



[[checkstyle-configuration]]

=== Checkstyle configuration



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



.pom.xml

----



true <1>

        true

         <2>

        true

         <3>



        

             <4>

                io.spring.javaformat

                spring-javaformat-maven-plugin

            

             <5>

                org.apache.maven.plugins

                maven-checkstyle-plugin

            

        



    

        

             <5>

                org.apache.maven.plugins

                maven-checkstyle-plugin

            

        

    



----

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

----



	

	



----



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:



```bash

$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/.editorconfig -o .editorconfig

$ touch .springformat

```



[[ide-setup]]

== IDE setup



[[intellij-idea]]

=== Intellij IDEA



In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.

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.



.spring-cloud-build-tools/

----

└── src

    ├── checkstyle

    │   └── checkstyle-suppressions.xml <3>

    └── main

        └── resources

            ├── checkstyle-header.txt <2>

            ├── checkstyle.xml <1>

            └── intellij

                ├── Intellij_Project_Defaults.xml <4>

                └── Intellij_Spring_Boot_Java_Conventions.xml <5>

----

<1> Default Checkstyle rules

<2> File header setup

<3> 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



.Code style



image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-code-style.png[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



image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-inspections.png[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



image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-checkstyle.png[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/main/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-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.

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

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



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



[[duplicate-finder]]

== Duplicate Finder



Spring Cloud Build brings along the  `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath.



[[duplicate-finder-configuration]]

=== Duplicate Finder configuration



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



.pom.xml

[source,xml]

----



    

        

            org.basepom.maven

            duplicate-finder-maven-plugin

        

    



----



For other properties, we have set defaults as listed in the https://github.com/basepom/duplicate-finder-maven-plugin/wiki[plugin documentation].



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.



If you need to add `ignoredClassPatterns` or `ignoredResourcePatterns` to your setup, make sure to add them in the plugin configuration section of your project:



[source,xml]

----



    

        

            org.basepom.maven

            duplicate-finder-maven-plugin

            

                

                    org.joda.time.base.BaseDateTime

                    .*module-info

                

                

                    changelog.txt

                

            

        

    



----



[[flattening-the-poms]]

= Flattening the POMs



To avoid propagating build setup that is required to build a Spring Cloud project, we're using the maven flatten plugin. It has the advantage of letting you use whatever features you need while publishing "clean" pom to the repository.



In order to add it, add the `org.codehaus.mojo:flatten-maven-plugin` to your `pom.xml`.



[source,xml]

----



    

        

            org.codehaus.mojo

            flatten-maven-plugin

        

    



----



[[reusing-the-documentation]]

= 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



[source,xml]

----



    

        docs

        

            

                

                    src/main/antora/resources/antora-resources

                    true

                

            

            

                

                    pl.project13.maven

                    git-commit-id-plugin

                

                

                    org.apache.maven.plugins

                    maven-dependency-plugin

                

                

                    org.codehaus.mojo

                    exec-maven-plugin

                

                

                    io.spring.maven.antora

                    antora-component-version-maven-plugin

                

                

                    org.antora

                    antora-maven-plugin

                

                

                    org.apache.maven.plugins

                    maven-antrun-plugin

                

                

                    maven-deploy-plugin

                

            

        

    

----



IMPORTANT: The order of plugin declaration is important!



In order for the build to generate the `adoc` file with all your configuration properties, your `docs` module should contain all the dependencies on the classpath, that you would want to scan for configuration properties.



If you want to modify which of the configuration properties are put in the table, you can tweak the `configprops.inclusionPattern` pattern to include only a subset of the properties (e.g. `spring.sleuth.*`).



Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.



[source,yml]

----

version: @antora-component.version@

prerelease: @antora-component.prerelease@



asciidoc:

  attributes:

    attribute-missing: 'warn'

    chomp: 'all'

    project-root: @maven.multiModuleProjectDirectory@

    github-repo: @docs.main@

    github-raw: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@

    github-code: https://github.com/spring-cloud/@docs.main@/tree/@github-tag@

    github-issues: https://github.com/spring-cloud/@docs.main@/issues/

    github-wiki: https://github.com/spring-cloud/@docs.main@/wiki

    spring-cloud-version: @project.version@

    github-tag: @github-tag@

    version-type: @version-type@

    docs-url: https://docs.spring.io/@docs.main@/docs/@project.version@

    raw-docs-url: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@

    project-version: @project.version@

    project-name: @docs.main@

----



[[updating-the-guides]]

= Updating the guides



We assume that your project contains guides under the `guides` folder.



```

.

└── guides

	├── gs-guide1

	├── gs-guide2

	└── gs-guide3

```



This means that the project contains 3 guides that would

correspond to the following guides in Spring Guides org.



- https://github.com/spring-guides/gs-guide1

- https://github.com/spring-guides/gs-guide2

- https://github.com/spring-guides/gs-guide3



If you deploy your project with the `-Pguides` profile like this



```

$ ./mvnw clean deploy -Pguides

```



what will happen is that for GA project versions, we will clone `gs-guide1`, `gs-guide2` and `gs-guide3` and update their contents with the ones being under your `guides` project.



You can skip this by either not adding the `guides` profile, or passing the `-DskipGuides` system property when the profile is turned on.



You can configure the project version passed to guides via the `guides-project.version` (defaults to `${project.version}`). The phase at which guides get updated can be configured by `guides-update.phase` (defaults to `deploy`).