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

Jump to bottom

Update CHANGELOG.md, update release scripts #1807

Merged
merged 1 commit into from
Feb 14, 2022
Merged

Update CHANGELOG.md, update release scripts #1807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Changelogs are maintained separately for each subproject. Please check out the
changelog file within each subproject folder for more details:

* [Datafusion CHANGELOG](./datafusion/CHANGELOG.md)
* [Datafusion Python Binding CHANGELOG](./python/CHANGELOG.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

python has been moved to its own crate, I believe.

* [Ballista CHANGELOG](./ballista/CHANGELOG.md)

For older versions, see [apache/arrow/CHANGELOG.md](https://github.com/apache/arrow/blob/master/CHANGELOG.md).
287 changes: 287 additions & 0 deletions datafusion/CHANGELOG.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## Sub-projects

The Datafusion repo contains 3 different releasable sub-projects: Datafusion, Ballista and Datafusion python binding.
The Datafusion repo contains 2 different releasable sub-projects: Datafusion, Ballista

We use Datafusion release to drive the release for the other sub-projects. As a
result, Datafusion version bump is required for every release while version
Expand Down Expand Up @@ -64,7 +64,7 @@ The CHANGELOG is managed automatically using
This script creates a changelog using github PRs and issues based on the labels
associated with them.

## Prepare release comimts and PR
## Prepare release commits and PR

Prepare a PR to update `CHANGELOG.md` and versions to reflect the planned
release.
Expand Down
1 change: 0 additions & 1 deletion dev/release/update_change_log-all.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ 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-python.sh
32 changes: 0 additions & 32 deletions dev/release/update_change_log-python.sh
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions dev/release/update_change_log.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ OUTPUT_PATH="${PROJECT}/CHANGELOG.md"
pushd ${SOURCE_TOP_DIR}

# reset content in changelog
git co "${SINCE_TAG}" "${OUTPUT_PATH}"
git checkout "${SINCE_TAG}" "${OUTPUT_PATH}"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my mac didn't like git co 😢

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha, sorry that's an alias i made up in my gitconfig, muscle memory...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem. I tip my hat to you for these scripts in general (automating the RAT in particular is genius, I normally just fix it up manually in arrow-rs)

# remove license header so github-changelog-generator has a clean base to append
sed -i '1,18d' "${OUTPUT_PATH}"
sed -i.bak '1,18d' "${OUTPUT_PATH}"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise, apparently sed from mac is slightly different than linux

https://stackoverflow.com/questions/5694228/sed-in-place-flag-that-works-both-on-mac-bsd-and-linux


docker run -it --rm \
-e CHANGELOG_GITHUB_TOKEN=$CHANGELOG_GITHUB_TOKEN \
-v "$(pwd)":/usr/local/src/your-app \
githubchangeloggenerator/github-changelog-generator:1.16.2 \
githubchangeloggenerator/github-changelog-generator \
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use latest

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might want to pin to the latest version number instead to avoid breaking changes in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 https://hub.docker.com/r/githubchangeloggenerator/github-changelog-generator/tags

Seems like latest has no other tag (as in latest is newer than 1.16.2 but there are no other numbered versions newer than 1.16.2) 😞

Screen Shot 2022-02-11 at 6 00 42 AM

--user apache \
--project arrow-datafusion \
--since-tag "${SINCE_TAG}" \
Expand All @@ -66,7 +66,7 @@ docker run -it --rm \
--output "${OUTPUT_PATH}" \
"$@"

sed -i "s/\\\n/\n\n/" "${OUTPUT_PATH}"
sed -i.bak "s/\\\n/\n\n/" "${OUTPUT_PATH}"

echo '<!---
Licensed to the Apache Software Foundation (ASF) under one
Expand Down