Skip to content

Commit

Permalink
[ci] Use make_changelog.py to generate the full changelog (#7152)
Browse files Browse the repository at this point in the history
Issue: #6114

### Brief Summary
The changelog automatically generated by GitHub only shows the PR list
related to the branch, and the cherry-picked commits are not inside the
list. So we should use our commit-based `make_changelog.py` to generate
the full changelog.
  • Loading branch information
lin-hitonami committed Jan 13, 2023
1 parent 60057fc commit bc11ee2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
1 change: 0 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -383,5 +383,4 @@ jobs:
uses: softprops/action-gh-release@v1
with:
body_path: CHANGELOG.md
generate_release_notes: true
tag_name: ${{ github.event.inputs.version }}
6 changes: 6 additions & 0 deletions misc/make_changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def format(c):
return f'{c.summary} (by **{c.author}**)'

notable_changes = {}
all_changes = []

details = load_pr_tags()

Expand Down Expand Up @@ -73,13 +74,18 @@ def format(c):
print(
f'** Warning: tag {tag.lower()} undefined in the "details" dict. Please include the tag into "details", unless the tag is a typo.'
)
all_changes.append(format(c))

res = 'Highlights:\n'
for tag in sorted(notable_changes.keys()):
res += f' - **{details[tag]}**\n'
for item in notable_changes[tag]:
res += f' - {item}\n'

res += '\nFull changelog:\n'
for c in all_changes:
res += f' - {c}\n'

return res


Expand Down

0 comments on commit bc11ee2

Please sign in to comment.