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

cd: auto-generate release notes for GitHub release page #1968

Open
lukpueh opened this issue Apr 21, 2022 · 2 comments
Open

cd: auto-generate release notes for GitHub release page #1968

lukpueh opened this issue Apr 21, 2022 · 2 comments
Labels

Comments

@lukpueh
Copy link
Member

lukpueh commented Apr 21, 2022

Description of issue or feature request:
#1946 adds a CD workflow to release build artifacts on PyPI and GH upon successful completion of the CI workflow for a pushed release tag.

The PR also replaces the manual process of adding release notes to the GH release page with an automatically added link:

body: 'See [CHANGELOG.md](https://github.com/' +
context.repo.owner + '/' + context.repo.repo + '/blob/' +
'${{ github.event.workflow_run.head_branch }}'+
'/docs/CHANGELOG.md) for details.'

Current behavior:
Auto-generated GH release pages only link to CHANGELOG.md.

Expected behavior:

Consider auto-generating more meaningful release notes (see GH docs)

@Nageshbansal
Copy link

hey @lukpueh , Is this issue resolved? if it isn't I would like to work on it.

@lukpueh
Copy link
Member Author

lukpueh commented Mar 14, 2023

Thanks for volunteering, @Nageshbansal! I'm definitely curious to see what auto-generated release notes would look like for this project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants