Project's missing RELEASE.md and CHANGELOG.md equivalents - Githubissues

executablebooks / github-activity

Simple markdown changelogs for GitHub repositories

https://github-activity.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

49 stars 11 forks source link

Project's missing RELEASE.md and CHANGELOG.md equivalents #88

Open consideRatio opened 1 year ago

consideRatio commented 1 year ago

I wanted to link to a changelog for this project but didn't find one, and then I saw also that the latest release was made with an error message in the commit message title which made me notice there wasn't a RELEASE.md procedure or automation to push to PyPI etc.

I suggest adopting:

a CHANGELOG.md file
a release.yaml github workflow, using pypi's trusted credentials as mentioned in the workflow
a tbump config
a RELEASE.md file, describing how to make a release using tbump in combination with the github workflow and github-activity itself to update the projects own changelog