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

Include release notes from the pull request body in markdown output #69

Open
choldgraf opened this issue Jul 24, 2022 · 1 comment · May be fixed by #70
Open

Include release notes from the pull request body in markdown output #69

choldgraf opened this issue Jul 24, 2022 · 1 comment · May be fixed by #70
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

Context

Currently our markdown changelog creator will just capture the Pull Request title, link, and author. However I've heard that some communities would also like to automate the "Release Notes" part of their release cycle by embedding a description of the PR in the PR's top comment. This would let you generate the more "narrative" release notes when you merged the PR, so that you don't have to do as much context-switching when a release is made.

Proposal

We could implement a flag like --include-release-notes that would do the following:

  • For each closed PR, in the top comment
  • Search for any lines that contain # Release Notes in them
  • Search for the next header block, or the end of the comment if no other header comes after
  • Grab the content of everything in between
  • Include this in the markdown output for that PR.

So the output would go from this:

- [Some PR title](some link)

to this

- [Some PR title](some link)

   The contents of the # Release Notes block.

Tasks and updates

No response
@choldgraf choldgraf added the enhancement New feature or request label Jul 24, 2022
@choldgraf
Copy link
Member Author

choldgraf commented Jul 24, 2022 •
edited
Loading

cc @tupui and @stefanv who originally mentioned this, maybe they have comments?

edit: I actually don't think this would be that complex, started playing around with a PR here:

@choldgraf choldgraf linked a pull request Jul 24, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ENH: Add release notes functionality executablebooks/github-activity
1 participant
@choldgraf