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

Leverage new automatic release notes functionality in github #58

Closed dhirschfeld closed 1 year ago

dhirschfeld commented 2 years ago

Description / Summary

GitHub now lets you automatically create release notes from a template: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#creating-a-template-for-automatically-generated-release-notes

Just opening this issue as an FYI, so feel free to close.

Value / benefit

Potentially less maintenance burden?

Implementation details

No response

Tasks to complete

No response

welcome[bot] commented 2 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

choldgraf commented 2 years ago

I saw that too! I haven't played around with it yet, but am wondering if it basically makes this tool unnecessary? What do you think?

dhirschfeld commented 2 years ago

I'm not too sure as I'm not actually familiar with this repo - I just saw it pop up in my feed and was intrigued as I've basically implemented the same thing... and am also wondering if I can simply port to the new built-in functionality.

I guess it depends on whether or not the built-in capability does everything you need, and potentially how easy it is to extend if required. I'm not sure of the answers as I haven't looked into it much as yet, but I'll be interested in any discussion about the pros & cons here! 👀

blink1073 commented 2 years ago

This repo has the nice feature of grouping your changes by category, can be used to bootstrap a changelog that did not have previous entries (pending #57), and in general gives us more flexibility. It has been extremely useful for JupyterLab and other repos using jupyter-releaser, which depends on this tool.

choldgraf commented 2 years ago

That is very helpful feedback - I don't understand the GitHub release notes thing to know whether it is fully redundant so I'll take your word on it 👍

choldgraf commented 1 year ago

I'm going to close this issue as it seems like we still have a lot of good use out of the categorization, grouping, and automation features of this tool, even though GitHub does also have somewhat overlapping functionality with it!