Skip to content

Commit e8dc2a9

Browse files
authored
Merge pull request #3040 from yue9944882/doc/release-doc-refresh
Doc: Update release doc for clarifying legacy branch workflow
2 parents 21e2113 + 671f9fe commit e8dc2a9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

RELEASES.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ branches.
1515
Maintainers meet the following requirements will be able to perform automated
1616
release to maven central via Github Action job named "Maven Release":
1717

18-
* Has "collaborator" permission or greater access (otherwise the can't run the
18+
* Has "collaborator" permission or greater access (otherwise can't run the
1919
job manually).
2020
* Should be in the OWNERS file.
2121

@@ -24,20 +24,21 @@ release to maven central via Github Action job named "Maven Release":
2424
#### Make sure the release job runs on the release branch
2525

2626
When cutting the next major release, firstly we need to fork out a new release
27-
branch named `release-<major>`. So the release job will execute the maven
28-
release plugin and push generated releasing commits to the release branch
29-
if the `release:prepare` process finishes successfully. Note that if we're
30-
bumping a new patch version from an existing release branch, this step can be
31-
omitted.
27+
branch named `release-<major>` or `release-legacy-<major>`. So the release job
28+
will execute the maven release plugin and push generated releasing commits to
29+
the release branch if the `release:prepare` process finishes successfully. Note
30+
that if we're bumping a new patch version from an existing release branch, this
31+
step can be omitted.
3232

3333
#### Filling release job input manually
3434

3535
The github action job will require three manual input:
3636

37-
* The POM releasing version, must be a valid semver `X.Y.Z` (without "v" prefix).
37+
* The POM releasing version, must be a valid semver `X.Y.Z` (without "v" prefix).
38+
For `master-java8` branch, the version should adhere to format `X.Y.Z-legacy`.
3839
* The next development POM version, conventionally we should bump a patch
3940
version from the current release version and add a `-SNAPSHOT` suffix. i.e.
40-
`X.Y.(Z+1)-SNAPSHOT`.
41+
`X.Y.(Z+1)-SNAPSHOT`. (for `master-java8` branch it's `X.Y.(Z+1)-legacy-SNAPSHOT`)
4142
* Dry-Run: Indicating whether the release job will push the generated release
4243
commits to the release branch and actually upload the artifacts.
4344

0 commit comments

Comments
 (0)