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

Add release notes and/or changelog to the repo #46

Open
Snailedlt opened this issue Sep 10, 2024 · 2 comments
Open

Add release notes and/or changelog to the repo #46

Snailedlt opened this issue Sep 10, 2024 · 2 comments

Comments

@Snailedlt
Copy link

It would be very useful to have some release notes and a changelog to give a quick overview of all the changes between each version. This would be especially useful for dependabot PR's, since they fetch release notes and changelogs automatically and show them in the PR.

Here's an example from a dependabot PR updating "ruff" in one of my repos: Snailedlt/Markdown-Videos#588
Preview:
image

In order to get release notes added to every dependabot PR you only need to create a release on github with some text. Examples from "ruff": https://github.com/astral-sh/ruff/releases
In order to add changelog to the dependabot PR's you'll need to add a CHANGELOG.md to your repo. Se for example this one by "ruff": https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md

Knowing what's released in each PR will make it easier to find out why something goes wrong when it does go wrong. See for example #45, where it's very hard to know which commits are a part of that release. If you make releases, a set of commits will also be associated with that release, giving you this neat commit overview in dependabot PR's aswell:
image

For reference this is how the dependabot PR looks for your package:
image

@tom-draper
Copy link
Owner

Noted! Release notes have been a challenge supporting 17 different web frameworks so far, but required releases have slowed down. It may be better to bundle them into a single release. I'll follow this for future releases.

@Snailedlt
Copy link
Author

If you do end up adding release notes, you can just copy that over to a changelog file too. That way we can see the entire release not history without clicking through each release.
I think there's some github actions that can automate this for you

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