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.

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

Refactor changelog #2839

Closed
wants to merge 8 commits into from
Closed

Refactor changelog #2839

wants to merge 8 commits into from

Conversation

ulysses-you
Copy link
Contributor

@ulysses-you ulysses-you commented Jun 9, 2022

Why are the changes needed?

refactor the changelog script to fix:

  • the nit of Apache Kyuubi(Incubating)
  • the format of the output changelog

How was this patch tested?

  • Add some test cases that check the changes thoroughly including negative and positive cases if possible

  • Add screenshots for manual tests if appropriate

  • Run test locally before make a pull request

@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Jun 9, 2022
## Changelog for Apache Kyuubi(Incubating) v1.5.2-incubating
- [Fix changelog nit](https://github.com/apache/incubator-kyuubi/commit/62b51aa3)
- [[KYUUBI #2746][INFRA][1.5] Improve NOTICE of binary release](https://github.com/apache/incubator-kyuubi/commit/35a4c488)
- [[KYUUBI-2422] Wrap close session with try-finally (#2836)](https://github.com/apache/incubator-kyuubi/commit/cbca761a)
Copy link
Member

Choose a reason for hiding this comment

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

this line crashes too

@@ -49,6 +49,6 @@ if [ "${LAST_RELEASE_TAG}" = "-h" ]; then
fi

## Add title for changelog doc.
echo "## Changelog for Apache Incubating Kyuubi $RELEASE_VERSION " > $CHANGELOG_PATH
echo "## Changelog for Apache Kyuubi(Incubating) $RELEASE_VERSION " > $CHANGELOG_PATH
## Append well-formatted git log to changelog file.
git log --pretty="- [%s]($KYUUBI_GITHUB_COMMIT_URL%h) " $LAST_RELEASE_TAG..$CURRENT_RELEASE_TAG | grep -v "\[RELEASE\]" >> $CHANGELOG_PATH
Copy link
Member

Choose a reason for hiding this comment

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

let's remove the list-item marker -

@ulysses-you
Copy link
Contributor Author

@yaooqinn refactor the changelog

@ulysses-you ulysses-you changed the title Add v1.5.2-incubating changelog Refactor changelog Jun 9, 2022
@yaooqinn
Copy link
Member

yaooqinn commented Jun 9, 2022

you can break this PR into

  1. fix the changelog script + 1.5.1
  2. 1.5.2

git log --pretty="[%s]($KYUUBI_GITHUB_COMMIT_URL%h)%n" $LAST_RELEASE_TAG..$CURRENT_RELEASE_TAG | grep -v "\[RELEASE\]" >> $CHANGELOG_PATH
Copy link
Member

Choose a reason for hiding this comment

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

%n is also unnecessary

@ulysses-you
Copy link
Contributor Author

you can break this PR into

  1. fix the changelog script + 1.5.1
  2. 1.5.2

@yaooqinn reverted the 1.5.2 changelog

- [[KYUUBI #2134] Respect Spark bundled log4j in extension modules](https://github.com/apache/incubator-kyuubi/commit/30dc84b)
- [[KYUUBI #2150] [DOCS] Fix Getting Started With Kyuubi on Kubernetes](https://github.com/apache/incubator-kyuubi/commit/e232a83)
## Changelog for Apache Kyuubi(Incubating) v1.5.1-incubating
[[KYUUBI #2354] Fix NPE in process builder log capture thread](https://github.com/apache/incubator-kyuubi/commit/5e76334e)
Copy link
Member

Choose a reason for hiding this comment

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

you should not remove 2 tailing spaces

@yaooqinn
Copy link
Member

yaooqinn commented Jun 9, 2022

LGTM except the pr desc

@ulysses-you
Copy link
Contributor Author

@yaooqinn updated the description

@ulysses-you
Copy link
Contributor Author

thanks, merging to master

@ulysses-you ulysses-you deleted the changelog branch June 9, 2022 12:11
@ulysses-you ulysses-you self-assigned this Jun 9, 2022
@ulysses-you ulysses-you added this to the v1.6.0 milestone Jun 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:build kind:documentation Documentation is a feature!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants