Include release notes from the pull request body in markdown output

[choldgraf]

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]

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:

• https://github.com/executablebooks/github-activity/pull/70