Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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

License

NotificationsYou must be signed in to change notification settings

spring-cloud/spring-cloud-release

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

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
Important
If you’re releasing milestones don’t forget to add-Pmilestone and if GA-Pcentral.

Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license,and follows a very standard Github development process, using Githubtracker for issues and merging pull requests into main. If you wantto contribute even something trivial please do not hesitate, butfollow the guidelines below.

Developer Certificate of Origin (DCO)

All commits must include aSigned-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin.For additional details, please refer to the blog postHello DCO, Goodbye CLA: Simplifying Contributions to Spring.

Code of Conduct

This project adheres to the Contributor Covenantcode ofconduct. By participating, you are expected to uphold this code. Please reportunacceptable behavior tocode-of-conduct@spring.io.

Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also beadded after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipseyou can import formatter settings using theeclipse-code-formatter.xml file from theSpringCloud Build project. If using IntelliJ, you can use theEclipse Code FormatterPlugin 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 isfor.

  • Add the ASF license header comment to all new.java files (copy from existing filesin the project)

  • Add yourself as an@author to the .java files that you modify substantially (morethan 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 (orother target branch in the main project).

  • When writing a commit message please followthese conventions,if you are fixing an existing issue please addFixes gh-XXXX at the end of the commitmessage (where XXXX is the issue number).

Checkstyle

Spring Cloud Build comes with a set of checkstyle rules. You can find them in thespring-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 aredisabled 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>(5)                <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. 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-suppressions.xml
<?xml version="1.0"?><!DOCTYPE suppressions PUBLIC"-//Puppy Crawl//DTD Suppressions 1.1//EN""https://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/main/.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 theSpring 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
Figure 1. Code style

Go toFile →Settings →Editor →Code style. There click on the icon next to theScheme section. There, click on theImport Scheme value and pick theIntellij IDEA code style XML option. Import thespring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml file.

Code style
Figure 2. Inspection profiles

Go toFile →Settings →Editor →Inspections. There click on the icon next to theProfile section. There, click on theImport Profile and import thespring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml file.

Checkstyle

To have Intellij work with Checkstyle, you have to install theCheckstyle plugin. It’s advisable to also install theAssertions2Assertj to automatically convert the JUnit assertions

Checkstyle

Go toFile →Settings →Other settings →Checkstyle. There click on the+ icon in theConfiguration 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 thecheckstyle.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:

Important
Remember to set theScan Scope toAll sources since we apply checkstyle rules for production and test sources.

Duplicate Finder

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

Duplicate Finder configuration

Duplicate finder isenabled by default and will run in theverify phase of your Maven build, but it will only take effect in your project if you add theduplicate-finder-maven-plugin to thebuild section of the project’spom.xml.

pom.xml
<build>    <plugins>        <plugin>            <groupId>org.basepom.maven</groupId>            <artifactId>duplicate-finder-maven-plugin</artifactId>        </plugin>    </plugins></build>

For other properties, we have set defaults as listed in theplugin documentation.

You can easily override them but setting the value of the selected property prefixed withduplicate-finder-maven-plugin. For example, setduplicate-finder-maven-plugin.skip totrue in order to skip duplicates check in your build.

If you need to addignoredClassPatterns orignoredResourcePatterns to your setup, make sure to add them in the plugin configuration section of your project:

<build>    <plugins>        <plugin>            <groupId>org.basepom.maven</groupId>            <artifactId>duplicate-finder-maven-plugin</artifactId>            <configuration>                <ignoredClassPatterns>                    <ignoredClassPattern>org.joda.time.base.BaseDateTime</ignoredClassPattern>                    <ignoredClassPattern>.*module-info</ignoredClassPattern>                </ignoredClassPatterns>                <ignoredResourcePatterns>                    <ignoredResourcePattern>changelog.txt</ignoredResourcePattern>                </ignoredResourcePatterns>            </configuration>        </plugin>    </plugins></build>

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

[8]ページ先頭
©2009-2025 Movatter.jp