Skip to content

Commit d23e433

Browse files
authored
docs: update release_process for changelog (apache#4668)
1 parent dd3a2da commit d23e433

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/source/contributor-guide/release_process.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ instructions on each step.
3434
- [ ] Generate release documentation
3535
- [ ] Update Maven version in release branch
3636
- [ ] Update version in main for next development cycle
37-
- [ ] Generate the change log and create PR against main
38-
- [ ] Cherry-pick the change log commit into the release branch
37+
- [ ] Generate the change log and PR it against the release branch
3938
- [ ] Build the jars
4039
- [ ] Tag the release candidate
4140
- [ ] Update documentation for the new release
@@ -47,6 +46,7 @@ instructions on each step.
4746
- [ ] Create GitHub release
4847
- [ ] Promote Maven artifacts to production
4948
- [ ] Push the release tag
49+
- [ ] Bring the finalized change log into main
5050
- [ ] Close the vote and announce the release
5151
- [ ] Post release:
5252
- [ ] Register the release with Apache Reporter
@@ -177,8 +177,10 @@ export GITHUB_TOKEN=<your-token-here>
177177
python3 generate-changelog.py 0.12.0 HEAD 0.13.0 > ../../docs/source/changelog/0.13.0.md
178178
```
179179

180-
Create a PR against the _main_ branch to add this change log and once this is approved and merged, cherry-pick the
181-
commit into the release branch.
180+
Open a PR adding this change log targeting the release branch. Generate it late, once backports to the release
181+
branch are complete; if more changes land on the release branch before the release candidate is tagged,
182+
regenerate it and update the PR. After the release is approved and tagged, open a separate PR to bring the same
183+
change log file into `main`.
182184

183185
### Build the jars
184186

@@ -246,7 +248,7 @@ repository
246248

247249
### Tag the Release Candidate
248250

249-
Ensure that the Maven version update and changelog cherry-pick have been pushed to the release branch before tagging.
251+
Ensure that the Maven version update and change log have been merged to the release branch before tagging.
250252

251253
Tag the release branch with `0.13.0-rc1` and push to the `apache` repo
252254

0 commit comments

Comments
 (0)