search

executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
47 stars 11 forks source link

ENH: Add release notes functionality #70

Open choldgraf opened 1 year ago

choldgraf commented 1 year ago

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

closes #69

choldgraf commented 1 year ago

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 commented 1 year ago

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

stefanv commented 1 year ago

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.

choldgraf commented 1 year ago

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

stefanv commented 1 year ago

@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.

choldgraf commented 1 year ago

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.