From 3c0a8bd81e50858b870345d2d8ece176b27af883 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Thu, 12 Aug 2021 16:59:00 -0400 Subject: [PATCH] Add note about changelog generation to README (#639) (#689) * Add note about changelog generation to README * make it prettier --- dev/release/README.md | 10 ++++++++++ dev/release/create-tarball.sh | 4 +++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/dev/release/README.md b/dev/release/README.md index bf03cbf65881..8e042e9079a8 100644 --- a/dev/release/README.md +++ b/dev/release/README.md @@ -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 diff --git a/dev/release/create-tarball.sh b/dev/release/create-tarball.sh index 231151905e09..06320171bb23 100755 --- a/dev/release/create-tarball.sh +++ b/dev/release/create-tarball.sh @@ -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. @@ -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 "---------------------------------------------------------"