18 Release process for v5

Mahmoud Ben Hassine edited this page 2024-02-21 11:58:38 +01:00

Table of Contents

• Release GAs to Maven Central
• Part 1: Prepare the release
• Part 2: Stage release on Artifactory
• Part 3: Promote release to Maven Central
• Part 4: Tag the release
• Part 5: Update the documentation
• Release Milestones to Artifactory
• Part 1: Deploy the milestone release to Artifactory
• Part 2: Test the deployed milestone release
• Part 3: Tag the release
• Part 4: Update the documentation
• Post release tasks

❗ Heads-up: The release process is different between milestones and GAs, so execute only the process that corresponds to the type of the release you are about to publish❗

Release GAs to Maven Central

Part 1: Prepare the release

1. In the branch to release (5.0.x, 5.1.x, etc), update the main pom.xml with release versions of Spring snapshot dependencies and upgrade other dependencies if needed. Here is an example: d594be1d. Make sure dependencies versions align with those used by the Spring Boot version that will consume the current release.
2. Run a full build with ./mvnw clean verify
3. Commit and push the changes in pom.xml with a message like: Prepare release 5.0.5

Part 2: Stage release on Artifactory

1. Go to Github Actions: https://github.com/spring-projects/spring-batch/actions.
2. Run the "Artifactory Staging" workflow from the branch to release ❗and provide the version to release.
3. Do a smoke test with the staged jars in http://repo.spring.io/libs-staging-local/org/springframework/batch. check the integrity of the artifacts to see if jars are not corrupted or empty, etc.

❗ Heads-up: The "Artifactory Staging" workflow is designed to be idempotent (it has no git side effects). If something is wrong with the staged release, the same workflow can be re-run with the same version and a new release will override the corrupted one on the staging repository.❗

Part 3: Promote release to Maven Central

1. Go to Github Actions: https://github.com/spring-projects/spring-batch/actions.
2. Run the "Maven Central Release" workflow from the main branch ❗ and provide the version to release. This will download the artifacts from the Artifactory staging repository, sign them with GPG and upload them to Maven Central.

Part 4: Tag the release

None of the previous Github Actions changes the version in the code and pushes the changes to the upstream repository. The version change is done manually on purpose. At this point, the release should have been staged, tested and promoted to Maven Central. It is now safe to change the version in the code and push it to the upstream repository. From the root directory of the project, run the following commands (change the version number accordingly):

$./mvnw versions:set -DgenerateBackupPoms=false -DnewVersion=5.0.5
$git commit -a -m "Release version 5.0.5"
$git tag -a v5.0.5 -m "Release version 5.0.5"
$./mvnw versions:set -DgenerateBackupPoms=false -DnewVersion=5.0.6-SNAPSHOT
$git commit -a -m "Next development version"
$git push upstream 5.0.x
$git push upstream v5.0.5

NB: The "v" prefix in the tag name is important, see https://github.com/spring-projects/spring-batch/issues/4183.

Part 5: Update the documentation

1. Go to Github Actions: https://github.com/spring-projects/spring-batch/actions.
2. Run the "Documentation Upload" workflow from the branch to release ❗and provide the version to release. This will generate a distribution of the documentation (java docs and XSDs) and upload it to the documentation server where needed.

Release Milestones to Artifactory

Part 1: Deploy the milestone release to Artifactory

1. Go to Github Actions: https://github.com/spring-projects/spring-batch/actions.
2. Run the "Artifactory Milestone Release" workflow by providing the milestone version to release. This will deploy the milestone release to https://repo.spring.io/libs-milestone-local/org/springframework/batch

Part 2: Test the deployed milestone release

Check uploaded jars in http://repo.spring.io/libs-milestone-local/org/springframework/batch and do a smoke test with the deployed milestone version: check the integrity of the artifacts to see if jars are not corrupted or empty, etc.

❗ Heads-up: The "Artifactory Milestone Release" workflow is designed to be idempotent (it has no git side effects). If something is wrong with the milestone release, the same workflow can be re-run with the same version and a new milestone will override the corrupted one on the milestone repository. ❗

Part 3: Tag the release

None of the previous Github Actions changes the version in the code and pushes the changes to the upstream repository. The version change is done manually on purpose. At this point, the release should have been staged, tested and promoted to Artifactory. It is now safe to change the version in the code and push it to the upstream repository. From the root directory of the project, run the following commands (change the version number accordingly):

$./mvnw versions:set -DgenerateBackupPoms=false -DnewVersion=5.2.0-M1
$git commit -a -m "Release version 5.2.0-M1"
$git tag -a v5.2.0-M1 -m "Release version 5.2.0-M1"
$./mvnw versions:set -DgenerateBackupPoms=false -DnewVersion=5.2.0-SNAPSHOT
$git commit -a -m "Next development version"
$git push upstream main
$git push upstream v5.2.0-M1

NB: The "v" prefix in the tag name is important, see https://github.com/spring-projects/spring-batch/issues/4183.

Part 4: Update the documentation

1. Go to Github Actions: https://github.com/spring-projects/spring-batch/actions.
2. Run the "Documentation Upload" workflow from the main branch and provide the milestone version to release. This will generate a distribution of the documentation (java docs and XSDs) and upload it to the documentation server where needed.

Post release tasks

1. Generate the release notes with the Generate Release notes action. You need to specify the milestone version (for example 5.0.5) and the version of the Github Changelog Generator (for example 0.0.8). Copy the generated content from the action's log, amend it as needed and use the result to create a release on Github. Heads-up: Add "Dependency upgrades" and "Full changelog" sections to the release notes, those are not generated by the "Github Changelog Generator" tool.
2. Update the project's page on Contentful with the latest release/snapshot versions.
3. Write a release announcement blog post.
4. Tweet about the release using the @SpringBatch handle.
5. Post a message in the #spring-release slack channel.
6. Close the GitHub milestone of the release
7. Update Spring dependencies to next snapshot versions in pom.xml. Here is an example: 4dda48df