5 ms·

Question/Poll: Do you prefer `changelog.md` or the releases tool built into github (IE: https://github.com/evantahler/actionhero/releases https://github.com/ev

• hobarrera 12y ago
  My reply below [1] talks about the pitfalls of the releaes too a bit. There's several other comments surrounding it already. That said, I feel that changelogs are way better, being more flexible and more in control of the user. I do feel that a lot of people can't keep one that well though. We don't need fine-grained details of every internal code refactor on a major-release changelog, since it's only relevant to devs (and they'll usually see the commit logs anyway). [1]: https://news.ycombinator.com/item?id=9237398 https://news.ycombinator.com/item?id=9237398
  • skywinder 12y ago
    > We don't need fine-grained details of every internal code refactor - Thats why you shouldn't dump commit messages to logs! > since it's only relevant to devs Since you are hosting your project on GitHub - you are expecting, that it not only for end-users, and for Developers also, huh? So, why not to maintain neat change log for them? (And use GitHub Releases for end-users change log, without "fine-grained details of every internal code refactor")
• insin 12y ago
  Both: keeping a changelog and copying a section to the latest relase after tagging it, since they're both Markdown.
  • skywinder 12y ago
    Yep. I would like to implement it also: https://github.com/skywinder/github-changelog-generator/issues/56 https://github.com/skywinder/github-changelog-generator/issu...