Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider adding a CHANGELOG boilerplate #25

Open
DavidGregory084 opened this issue Jun 7, 2022 · 3 comments
Open

Consider adding a CHANGELOG boilerplate #25

DavidGregory084 opened this issue Jun 7, 2022 · 3 comments

Comments

@DavidGregory084
Copy link
Member

I've used the Keep a changelog format in a few projects now and I'm a fan of it, perhaps we could add this to typelevel.g8 as well?

@rossabaker
Copy link
Member

From experience, it's a burden to maintain a changelog in addition to GitHub releases. This is a shame, because GitHub releases are not part of the git history, not portable, and therefore Are Considered Harmful

In olden times, there was a convention of release notes in a notes/ directory that were read by an sbt plugin and published to a Tumblr called implicit.ly, but kept a record in git. It was great. I think there's a missing SBT plugin that concatenates our GitHub releases into a portable, versioned CHANGELOG... or, alternatively, creates GitHub releases from notes in Git.

@armanbilge
Copy link
Member

I'm lazy to keep a changelog, but I have to say another advantage is that they synthesize a PR that other maintainers can review/edit/contribute to. This process has been helpful for large projects like http4s.

@DavidGregory084
Copy link
Member Author

Spotted this completely different approach to managing versions and changelogs a couple weeks ago - the CHANGELOG.md file drives everything.
IMO it's a bit of a pain to use Markdown for this and it leads to merge conflicts in the "Unreleased" section every time a PR is merged, but the idea could be interesting if it used a more structured format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants