Skip to content

Commit

Permalink
Add note about changelog generation to README (#639) (#689)
Browse files Browse the repository at this point in the history
* Add note about changelog generation to README

* make it prettier
  • Loading branch information
alamb authored Aug 12, 2021
1 parent 7c98c4c commit 3c0a8bd
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
10 changes: 10 additions & 0 deletions dev/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ The CHANGELOG is created automatically using
This script creates a changelog using github issues and the
labels associated with them.

## CHANGELOG for maintenance releases

At the time of writing, the `update_change_log.sh` script does not work well with branches as it seems to intermix issues that were resolved in master.

To generate a bare bones CHANGELOG for maintenance releases, you can use a command similar to the following to get all changes between 5.0.0 and the active_release.

```shell
git log --pretty=oneline 5.0.0..apache/active_release
```

# Mechanics of creating a release

## Prepare the release branch and tags
Expand Down
4 changes: 3 additions & 1 deletion dev/release/create-tarball.sh
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ The proposed release tarball and signatures are hosted at [2].
The changelog is located at [3].
Please download, verify checksums and signatures, run the unit tests,
and vote on the release.
and vote on the release. There is a script [4] that automates some of
the verification.
The vote will be open for at least 72 hours.
Expand All @@ -97,6 +98,7 @@ The vote will be open for at least 72 hours.
[1]: https://github.com/apache/arrow-rs/tree/${release_hash}
[2]: ${url}
[3]: https://github.com/apache/arrow-rs/blob/${release_hash}/CHANGELOG.md
[4]: https://github.com/apache/arrow-rs/blob/master/dev/release/verify-release-candidate.sh
MAIL
echo "---------------------------------------------------------"

Expand Down

0 comments on commit 3c0a8bd

Please sign in to comment.