Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I use the git log to feed my changelog. I prefix the stuff that's supposed to go in the release notes with a asterix and the technical boring stuff is just a normal line. Then at release time I have a script that pulls the asterix prefixed lines from the change log into the RELEASENOTES.md. I wouldn't want to bother with more.


How do you know that your asterixed commit should go into the release notes? What if...

* fixed thing X so that user can do Y

broke things so that another commit is needed:

* fixed X again, so that user can finally do Y (for realz this time)

This would not make a great release note.


you just wouldn't put a * in front of the second one


or you might have an alternate prefix for "things that go in development build changelogs but not final changelogs", e.g. "-"


When you squash and merge a PR, GitHub will by default prefix commit messages of the squashed commits with an astrix.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: