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

Is there a changelog? #266

Open
franzliedke opened this issue Aug 29, 2024 · 3 comments
Open

Is there a changelog? #266

franzliedke opened this issue Aug 29, 2024 · 3 comments

Comments

@franzliedke
Copy link

Dependabot prompted us to finally update this dependency. We've been lagging behind quite a bit. 🙈

Now our CI is failing and I am trying to debug those.
I've been trying to find information about user-facing changes. There seems to be no changelog and no release on GitHub. Am I missing any place?

There has even been a major release (v3, we're still on v2). 😬


Thanks for this project. 💚

@tijn
Copy link
Collaborator

tijn commented Aug 29, 2024

@franzliedke it's maybe not a true changelog but our commits on the master branch show everything that's changed, including version updates. Each new version corresponds with a release on npmjs.com. I guess we should also put the release here on GitHub; but we don't do that yet... (please send a pull request 😉 )

@franzliedke
Copy link
Author

@tijn Thanks for the quick response. 🤝

Yeah, I've been digging through the Compare view / commit list, but TBH that's very far from a real changelog. There is a lot of noise in there (dependency updates, merge commits, internal changes) that don't matter to end users, and the commits aren't always written with the end user in mind.

Personally, I think that too many changelog tools, especially in the JS ecosystem, focus on automation. That's understandable from a maintainer's perspective, but from a user's, it barely helps. I want to know a) whether I can safely upgrade and b) what's new for me.

Whoops, now I got side-tracked.

I guess we should also put the release here on GitHub; but we don't do that yet... (please send a pull request 😉 )

As much as I'd be happy to help, I'm not sure I understand. I can't PR what GitHub calls "releases". (And I lack the context / maintainer knowledge to PR a useful changelog for historic changes anyway.) What do you mean?

@tijn
Copy link
Collaborator

tijn commented Aug 29, 2024

As much as I'd be happy to help, I'm not sure I understand. I can't PR what GitHub calls "releases". (And I lack the context / maintainer knowledge to PR a useful changelog for historic changes anyway.) What do you mean?

@franzliedke we have a few scripts in package.json that do the release for us; I thought we could automate tagging a release on GitHub too. But maybe I'm wrong, and besides, it won't help you at all since it will not retrospectively create a changelog.

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

2 participants