mobx-state-tree icon indicating copy to clipboard operation
mobx-state-tree copied to clipboard

Single file, curated CHANGELOG

Open tony opened this issue 3 years ago • 1 comments

Hi, thank you for the project! This is an opinionated issue - I find GitHub releases basically impossible to use.

I believe any departure from a single file changelog that's curated makes it more difficult to comprehend.

Feature request A changelog file that's curated by the maintainers

Is your feature request related to a problem? Please describe. Yes, I believe the way it was done <4.0 was better. I think the effort to maintain a changelog the former way is worth it in the long run.

Describe the solution you'd like A changelog that's one file, hand made by maintainer, each release. Most important stuff for the user (sorted by importance, e.g. breaking changes, new features, bug fixes)

The reason why is I think the maintainer is in the best position to tailor what's important to users when they cut the release. I think automated release systems obscure what's happening - after a couple of releases, it becomes highly frustrating (for me at least) to use 🤣

Describe alternatives you've considered There's no alternative but it seems changelog.md was removed in favor of releases in >4.0 in favor of GitHub Releases.

Additional context See https://github.com/webpack/webpack/issues/15318 for the rationale / example I've given

GitHub Releases (fragmented, undifferentiated, and in a "blog" subsite detached from any changelog file):

https://user-images.githubusercontent.com/26336/185774527-2150ac43-9a6c-4281-84d4-7ccb5db1924e.mp4

Babel's single file changelog (everything's on one page, at least):

https://user-images.githubusercontent.com/26336/185774539-f02b0c23-493d-4850-b70e-ff162a4f4ff9.mp4

Are you willing to (attempt) a PR?

  • [x] Yes

    But a maintainer would be a better for this. Also it would be appropriate to curate releases,

tony avatar Aug 21 '22 03:08 tony

I should also rewind: I am in a chipper disposition and am happy with the project. Just have a universal distaste for GH Releases.

I've nothing wrong with GH Releases to supplement things, but I'd never suggest it as a replacement for an actual changelog

Example from a project of mine: CHANGES file, CHANGES on docs site, Release

tony avatar Aug 21 '22 04:08 tony

Hey @tony! Sorry no one got back to you for so long.

I'm going to convert this to a discussion topic, rather than an issue. I don't want to close it out entirely, but I am just sort of getting up to speed on the core team here and I don't have a yes/no for you.

Thanks for the idea, and apologies once more for the delay!

coolsoftwaretyler avatar Jun 25 '23 20:06 coolsoftwaretyler