Skip to content

Commit 6d66489

Browse files
committed
Update release procedure to keep significant README changes off master during pre-release
1 parent 869fff5 commit 6d66489

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/releasing.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,19 @@ Release candidate versions
3434
less than 30 minutes (long before the artifacts become searchable on the
3535
main Maven Central website).
3636
37-
7. Push to GitHub:
37+
7. Push to GitHub.
38+
39+
If the pre-release makes significant changes to the project README, such
40+
that the README does not accurately reflect the latest non-pre-release
41+
version, push the changes on a separate release branch:
42+
43+
```
44+
$ git checkout -b release-1.4.0
45+
$ git push origin release-1.4.0 1.4.0-RC1
46+
```
47+
48+
If the README still accurately reflects the latest non-pre-release version,
49+
you can simply push to master instead:
3850
3951
```
4052
$ git push origin master 1.4.0-RC1

0 commit comments

Comments
 (0)