Spring Cloud projects reuse the same pattern of building and deploying the applications. That’s why this tool makes it easy to automate the release / dependency update process of our applications.
For a single project
- Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)
Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud Release)
- throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM
Performs the build and checks if the
docsmodules have properly created the documentation- throws an exception when in the
docsmodule there’s an unresolved tag in any HTML file
- throws an exception when in the
- Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS)
- Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS)
- Runs the deployment of the artifacts
- Publishes the docs (to
spring-cloud-staticfor non-snapshots, togh-pagesfor snapshots) - Reverts back to snapshots, bumps the version by a patch (
1.0.1.RELEASE→1.0.2.BUILD-SNAPSHOT) (ONLY FOR RELEASE VERSIONS) - Closes the milestone on Github (e.g.
v1.0.1.RELEASE) (ONLY FOR NON-SNAPSHOT VERSIONS)
![[Important]](images/important.png) | Important |
|---|---|
Starting with version that does Sagan integration, you MUST pass the OAuth token, -otherwise the application will fail to start |
After project release
- Generates an email template under
target/email.txt(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a blog template under
target/blog.md(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a tweet template under
target/tweet.txt(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a release notes template under
target/notes.md(ONLY FOR NON-SNAPSHOT VERSIONS) - Updates project information in Sagan (http://spring.io) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)
- For
GA/SRrelease will create an issue in Spring Guides under https://github.com/spring-guides/getting-started-guides/issues/ - For
GA/SRrelease will update the links under https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current - Will update the release train project page (for Spring Cloud it will be
https://github.com/spring-projects/spring-cloud)
- Uses the fixed versions to clone and check out each project (e.g.
spring-cloud-sleuth: 2.1.0.RELEASE) From the version analyzes the branch and checks it out. E.g.
- for
spring-cloud-release’s `Finchley.RELEASEversion will resolve eitherFinchleybranch or will fallback tomasterif there’s noFinchleybranch. - for
spring-cloud-sleuth’s `2.1.0.RELEASEversion will resolve2.1.xbranch
- for
- Performs the release tasks per each project
- Performs the post release tasks at the end of the release
- Will update and run smoke test samples (for Spring Cloud it will be
https://github.com/spring-cloud/spring-cloud-core-tests) - Will clone provided test samples and will update all versions to the latest ones
- Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be
https://github.com/spring-projects/spring-cloud.wiki.git)
| Important |
|---|---|
For the meta-releaser to work we assume that the path to the +otherwise the application will fail to start |
After project release
- Generates an email template under
target/email.txt(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a blog template under
target/blog.md(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a tweet template under
target/tweet.txt(ONLY FOR NON-SNAPSHOT VERSIONS) - Generates a release notes template under
target/notes.md(ONLY FOR NON-SNAPSHOT VERSIONS) - Updates project information in Sagan (https://spring.io) (ONLY FOR SNAPSHOT / RELEASE VERSIONS)
- For
GA/SRrelease will create an issue in Spring Guides under https://github.com/spring-guides/getting-started-guides/issues/ - For
GA/SRrelease will update the links under https://github.com/spring-cloud/spring-cloud-static/tree/gh-pages/current - Will update the release train project page (for Spring Cloud it will be
https://github.com/spring-projects/spring-cloud)
- Uses the fixed versions to clone and check out each project (e.g.
spring-cloud-sleuth: 2.1.0.RELEASE) From the version analyzes the branch and checks it out. E.g.
- for
spring-cloud-release’s `Finchley.RELEASEversion will resolve eitherFinchleybranch or will fallback tomasterif there’s noFinchleybranch. - for
spring-cloud-sleuth’s `2.1.0.RELEASEversion will resolve2.1.xbranch
- for
- Performs the release tasks per each project
- Performs the post release tasks at the end of the release
- Will update and run smoke test samples (for Spring Cloud it will be
https://github.com/spring-cloud/spring-cloud-core-tests) - Will clone provided test samples and will update all versions to the latest ones
- Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be
https://github.com/spring-projects/spring-cloud.wiki.git)
| Important |
|---|---|
For the meta-releaser to work we assume that the path to the
custom configuration file for each project is always |
Members of the Spring Cloud Team typically use this tool as follows. They first clone the releaser locally and build the jar manually
$ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
$ cd spring-cloud-release-tools
@@ -131,7 +131,7 @@ Example for application arguments: java -jar target/spring
the releaser will pass any system properties to the build / deploy command, such as system properties
with keys and we need them to be passed inside the command executed by the releaser.![[Tip]](images/tip.png)