ENH: Add release notes functionality #70
Conversation
There was a problem hiding this comment.
This looks great, thanks @choldgraf! Do you use a custom script to generate reports from github-activity, or is there another tool for that?
github_activity/github_activity.py
Outdated
| if include_release_notes: | ||
| lines = description.split("\n") | ||
| headers = [ii.startswith("#") for ii in lines] | ||
| release_notes = [ii for ii in headers if "# release notes" in ii.lower()] |
There was a problem hiding this comment.
I like that this allows for subheadings and different capitalizations!
Could you explain more? I'm not sure what you mean. I usually just call this from the command line ( |
|
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 |
|
The first issue I ran into is that |
|
ooh good catch, it's not strictly required, only if you don't have a GITHUB_TOKEN passed already. That was added in: So I think that's a bug |
|
@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. |
|
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. |
This is a work-in-progress to see how simple it would be to add release notes functionality to this package.
closes #69