github-activity icon indicating copy to clipboard operation
github-activity copied to clipboard

Published 20 hours ago • verified publisher icon executablebooks

ENH: Add release notes functionality

Open choldgraf opened this issue 2 years ago • 6 comments

This is a work-in-progress to see how simple it would be to add release notes functionality to this package.

closes #69

choldgraf avatar Jul 24 '22 13:07 choldgraf

Do you use a custom script to generate reports from github-activity

Could you explain more? I'm not sure what you mean. I usually just call this from the command line (cd myrepo; github-activity) and then copy-paste the markdown into either CHANGELOG.md or a GitHub release notes. I've found it is helpful to have that one final manual step to encourage some 👀 on the result.

choldgraf avatar Jul 25 '22 08:07 choldgraf

OK I think that this one should be ready to go. @stefanv or @tupui or @jarrodmillman want to try it out? See the docs for some light instructions

choldgraf avatar Jul 31 '22 19:07 choldgraf

The first issue I ran into is that github-activity needs the gh binary, but I don't see this requirement in the README or the docs.

stefanv avatar Jul 31 '22 19:07 stefanv

ooh good catch, it's not strictly required, only if you don't have a GITHUB_TOKEN passed already. That was added in:

  • #66

So I think that's a bug

choldgraf avatar Jul 31 '22 19:07 choldgraf

@choldgraf At the skimage community call, we've been wondering how to use this functionality and also indicate categories for updates, such as API update, documentation, breaking changes, etc.

stefanv avatar Sep 27 '22 17:09 stefanv

I'm not sure when I'll have time to get to this - so I welcome anybody to make changes to this PR or make a new one to make it more useful.

choldgraf avatar Sep 28 '22 13:09 choldgraf