$ git clone git@github.com:spring-cloud/spring-cloud-release.git
+$ cd spring-cloud-release
+$ git checkout -b springCloudBuildRelease- JSchException: Auth fail @@ -806,11 +812,247 @@ $ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.wor
-
+
Create a branch (for example,
+springCloudBuildRelease) in a project that contains a BOM (for example, spring-cloud-release). The following example shows how to do so:
+ -
+
Update all versions as if you were doing a release train. We need to update the project’s versions, Boot version, and dependencies versions, too. Let us assume that we will eventually be doing a release train for the
+Hoxton.M1release, Spring Boot to the latest available one, andspring-cloud-commonsto1.2.3.BUILD-SNAPSHOT. The following example shows how to do so:
+ -
+
Pick the proper releaser project (for example,
+spring-cloud-build-releaser). The following image shows the settings for this example:
+ -
+
Next, click
+Build with parameters. The following image shows the UI for doing so:
+ -
+
Finally, click
+Build.
+ -
+
In your project (which must contain a BOM, such as
+spring-cloud-release) you have to have a branch, where you store properties with versions of your projects. For example, the branch name can be jenkins-releaser-config). The folloiwng example shows how to do so:
+ -
+
Create a file that contains all properties for a given release train. The name of the release train should be lowercase, and dots should be converted to underscores. For example, for the
+Greenwich.SR2release train we need to have a file namedgreenwich_sr2.properties. The following example shows how to do so:
+ -
+
We need to update the file with all versions for the release train. The properties file contains an ordered list of
+releaser.fixed-versions[project-name]=project-versionentries, as the following listing shows:
+ -
+
Pick the proper meta-releaser project (for example,
+spring-cloud-meta-releaser), as the following image shows:
+ -
+
Next, click
+Build with parameters.
+ -
+
Finally, click
+Build.
+
+
+Releasing through Jenkins
+
+
+
+
+| + + | ++Whenever a release process is broken, Jenkins marks it with a red ball and breaks the build. Whenever a post-release action went wrong but the release is successful, Jenkins marks the build with a yellow ball and marks the build as unstable. + | +
+
+Releasing a Single Project
+
+
+Let us assume that we are to release spring-cloud-build project. We need to do the following steps:
+
+-
+
+
+
+
+
+
+-
+
+
+
+
+// setting the release train value
+$ ./mvnw versions:set -DnewVersion=Hoxton.M1 -DgenerateBackupPoms=false -DprocessAllModules=true
+// Update all parent versions
+$ ./mvnw versions:update-parent -DgenerateBackupPoms=false -DprocessAllModules=true
+// Setting the necessary dependencies
+$ ./mvnw versions:set-property -Dproperty=spring-cloud-commons.version -DnewVersion=1.2.3.BUILD-SNAPSHOT -pl spring-cloud-dependencies -DgenerateBackupPoms=false
+// NOTE!!!
+// Verify that the versions set by Maven are correct!!
+$ git diff
+// commit and push the branch
+$ git add . && git commit -m "Updating project for Spring Cloud Build release" && git push origin springCloudBuildRelease
+
+
+
+| + + | +
+If you’re doing a e.g. M1 release, remember to not have any snapshot versions in this branch.
+ |
+
+
+Since the project is prepared, go to Jenkins and select the Releaser view, which the following image shows:
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+Pick from which branch you would like the project (for example, spring-cloud-build - defaults to master) to be built and update the RELEASER_POM_BRANCH to point to the checked-out branch of Spring Cloud Release (for example, springCloudBuildRelease). You can pick whether you want to perform only post-release tasks or the whole release.
+
+-
+
+
+You are done!
+
+
+As a post action, do not forget to remove the branch. The following example shows how to do so:
+
+
+
+
+// to synchronize any deleted branches (don't run this if you want leave any deleted branches that were deleted in the origin)
+$ git fetch -p
+$ git branch -d springCloudBuildRelease
+$ git push origin --delete springCloudBuildRelease
+
+Releasing a Release Train
+
+
+We call a release train a meta-release. In order to perform one, you need to:
+
+-
+
+
+
+
+$ git clone git@github.com:spring-cloud/spring-cloud-release.git
+$ cd spring-cloud-release
+$ git checkout jenkins-releaser-config
+
+-
+
+
+
+
+$ touch greenwich_sr2.properties
+
+-
+
+
+
+
+$ echo "releaser.fixed-versions[spring-boot]=2.1.5.RELEASE
+releaser.fixed-versions[spring-cloud-build]=2.1.5.RELEASE
+releaser.fixed-versions[spring-cloud-commons]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-function]=2.0.2.RELEASE
+releaser.fixed-versions[spring-cloud-stream]=Fishtown.SR3
+releaser.fixed-versions[spring-cloud-aws]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-bus]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-task]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-config]=2.1.3.RELEASE
+releaser.fixed-versions[spring-cloud-netflix]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-cloudfoundry]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-kubernetes]=1.0.2.RELEASE
+releaser.fixed-versions[spring-cloud-openfeign]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-consul]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-gateway]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-security]=2.1.3.RELEASE
+releaser.fixed-versions[spring-cloud-sleuth]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-zookeeper]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-contract]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-gcp]=1.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-vault]=2.1.2.RELEASE
+releaser.fixed-versions[spring-cloud-release]=Greenwich.SR2" >> greenwich_sr2.properties
+$ git add greenwich_sr2.properties && git commit -m "Added Greenwich.SR2 properties" && git push origin jenkins-releaser-config
+
+Since the project is prepared, go to Jenkins and select the Releaser view, as the following image shows:
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+-
+
+
+
+
+
+
+
+
+You have quite a few options to pick, but the most important one is to set the value of the RELEASE_VERSION to the given release train version (for example, Greenwich.SR2). Continue updating the rest of the fields if necessary and read the field descriptions and this documentation for more information.
+
+-
+
+
+You are done!
+FAQ
JSchException: Auth fail
-
I got such an exception
+You may get an exception similar to the following:
@@ -830,7 +1072,7 @@ Caused by: com.jcraft.jsch.JSchException: Auth fail
-
To fix that just call
+To fix that just call, run the following commands before running the app:
@@ -840,9 +1082,6 @@ $ eval `ssh-agent`
$ ssh-add ~/.ssh/id_rsa
-
before running the app
-