Skip to content

Commit fb9e2d3

Browse files
committed
Polish the release process with extra checks.
To reduce risk and ensure a proper release, extra steps and a checklist have been added to the release process. Resolves #1237.
1 parent b908842 commit fb9e2d3

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.adoc

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,39 @@ You can also import the project into your IDE.
2929

3030
== Making a release
3131

32+
Before you make a release, follow this checklist:
33+
34+
* Are you use the latest milestone/release candidate/release of Spring Framework? If not, upgrade. (Don't forget `spring-buildsnapshot` profile.)
35+
* Are you use the latest milestone/release candidate/release of Spring Security? If not, upgrade. (Don't forget `spring-buildsnapshot` profile.)
36+
* Are you setup with the right version of Java? If not switch. (Java 17 for 4.0+, Java 8 for everything else.)
37+
* Is it time to switch from milestone to release candidate? Or from release candidate to release?
38+
39+
NOTE: The _actual_ building and releasing is done on CI inside a Docker container, ensuring little risk between versions of Java.
40+
But part of the release process requires a local check, which DOES depend upon your environment.
41+
3242
1. Create a new release (on the main branch).
3343
+
3444
----
3545
% ci/create-release.sh <release version> <next snapshot version>
3646
----
3747
+
38-
2. With the release tagged, push the tagged version to the release branch.
48+
2. With the release tagged, update the release branch to the newly created tag.
3949
+
4050
----
4151
% git checkout -b release
4252
% git reset --hard <tag>
53+
----
54+
+
55+
3. Verify this builds locally and passes all tests.
56+
+
57+
----
58+
% ./mvnw clean package
59+
% ./mvnw -Pspring-buildsnapshot clean package
60+
----
61+
+
62+
4. Push the tagged version to the release branch.
63+
+
64+
----
4365
% git push -f origin release
4466
----
4567

0 commit comments

Comments
 (0)