spring-cloud-release

by spring-cloud

spring-cloud / spring-cloud-release

Spring Cloud Release Train - dependency management across a wide range of Spring Cloud projects.

450 Stars 119 Forks Last release: Not found Apache License 2.0 512 Commits 97 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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

Spring Cloud Release Train is a curated set of dependencies across a range of Spring Cloud projects. You consume it by using the spring-cloud-dependencies POM to manage dependencies in Maven or Gradle. The release trains have names, not versions, to avoid confusion with the sub-projects. The names are an alphabetic sequence (so you can sort them chronologically) with names of London Tube stations ("Angel" is the first release, "Brixton" is the second).

== Generating release train documentation

In order to generate the release train documentation, please update the project with versions for a given release train and then execute the following command:

$ ./mvnw clean install -Pdocs,train-docs -pl train-docs

In order to upload the documentation to the documentation server just execute the following command:

$ ./mvnw clean deploy -Pdocs,train-docs -pl train-docs

== Contributing

:spring-cloud-build-branch: master

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.

=== 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 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 conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]

=== 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/master/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 master (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

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

<?xml version="1.0"?> <!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "https://www.puppycrawl.com/dtds/suppressions11.dtd">

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

.spring-cloud-build-tools/

└── src    ├── checkstyle    │   └── checkstyle-suppressions.xml <3>    └── main    └── resources    ├── checkstyle-header.txt <2>    ├── checkstyle.xml <1>    └── intellij       ├── IntellijProjectDefaults.xml <4>

      └── IntellijSpringBootJavaConventions.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/{spring-cloud-build-branch}/docs/src/main/asciidoc/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/{spring-cloud-build-branch}/docs/src/main/asciidoc/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/{spring-cloud-build-branch}/docs/src/main/asciidoc/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/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-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
    .

IMPORTANT: Remember to set the

Scan Scope
to
All sources
since we apply checkstyle rules for production and test sources.

== Building and Deploying

Since there is no code to compile in the starters they should do not need to compile, but a compiler has to be available because they are built and deployed as JAR artifacts. To install locally:


$ mvn install -s .settings.xml

and to deploy snapshots to repo.spring.io:


$ mvn install -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local

for a RELEASE build use


$ mvn install -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-release-local

and for Maven Central use


$ mvn install -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).

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.