Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MINOR: Parameterize changelog script #2484

Merged
merged 3 commits into from
May 8, 2022
Merged

MINOR: Parameterize changelog script #2484

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da4fcd6
modify script to respect release branch
jychen7 Apr 9, 2022
b88ad07
Separate usage and example
jychen7 May 8, 2022
3d3ac9d
Update dev/release/README.md
andygrove May 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions dev/release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@ git commit -a -m 'Update version'

### Update CHANGELOG.md

Manually edit the base version tag argument in
`dev/release/update_change_log-{ballista,datafusion}.sh`. Commits
between the base verstion tag and the latest upstream master will be used to
Define release branch (e.g. `master`), base version tag (e.g. `7.0.0`) and future version tag (e.g. `8.0.0`). Commits between the base verstion tag and the release branch will be used to
populate the changelog content.

You will need a GitHub Personal Access Token for the following steps. Follow
Expand All @@ -124,7 +122,7 @@ to generate one if you do not already have one.

```bash
# create the changelog
CHANGELOG_GITHUB_TOKEN=<TOKEN> ./dev/release/update_change_log-all.sh
CHANGELOG_GITHUB_TOKEN=<TOKEN> ./dev/release/update_change_log-all.sh master 8.0.0 7.0.0
# review change log / edit issues and labels if needed, rerun until you are happy with the result
git commit -a -m 'Create changelog for release'
```
Expand Down
9 changes: 6 additions & 3 deletions dev/release/update_change_log-all.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@
set -e

# Usage:
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-datafusion.sh
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-all.sh <branch> <release_tag> <base_tag>
# Example:
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-all.sh master 8.0.0 7.1.0
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-all.sh maint-7.x 7.1.0 7.0.0

SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SOURCE_TOP_DIR="$(cd "${SOURCE_DIR}/../../" && pwd)"

${SOURCE_DIR}/update_change_log-datafusion.sh
${SOURCE_DIR}/update_change_log-ballista.sh
${SOURCE_DIR}/update_change_log-datafusion.sh $1 $2 $3
${SOURCE_DIR}/update_change_log-ballista.sh $1 $2 $3
14 changes: 8 additions & 6 deletions dev/release/update_change_log-ballista.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,16 @@
#

# Usage:
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-ballista.sh
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-ballista.sh master ballista-0.7.0 ballista-0.6.0

SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SOURCE_TOP_DIR="$(cd "${SOURCE_DIR}/../../" && pwd)"
RELEASE_BRANCH=$1
RELEASE_TAG=$2
BASE_TAG=$3

CURRENT_VER=$(grep version "${SOURCE_TOP_DIR}/ballista/rust/client/Cargo.toml" | head -n 1 | awk '{print $3}' | tr -d '"')
SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
${SOURCE_DIR}/update_change_log.sh \
ballista \
ballista-0.6.0 \
"${BASE_TAG}" \
--exclude-tags-regex "python-.+" \
--future-release "ballista-${CURRENT_VER}"
--future-release "${RELEASE_TAG}" \
--release-branch "${RELEASE_BRANCH}"
15 changes: 9 additions & 6 deletions dev/release/update_change_log-datafusion.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,17 @@
#

# Usage:
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-datafusion.sh
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-datafusion.sh master 8.0.0 7.1.0
# CHANGELOG_GITHUB_TOKEN=<TOKEN> ./update_change_log-datafusion.sh maint-7.x 7.1.0 7.0.0

SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SOURCE_TOP_DIR="$(cd "${SOURCE_DIR}/../../" && pwd)"
RELEASE_BRANCH=$1
RELEASE_TAG=$2
BASE_TAG=$3

CURRENT_VER=$(grep version "${SOURCE_TOP_DIR}/datafusion/core/Cargo.toml" | head -n 1 | awk '{print $3}' | tr -d '"')
SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
${SOURCE_DIR}/update_change_log.sh \
datafusion \
7.0.0 \
"${BASE_TAG}" \
--exclude-tags-regex "(python|ballista)-.+" \
--future-release "${CURRENT_VER}"
--future-release "${RELEASE_TAG}" \
--release-branch "${RELEASE_BRANCH}"