-
Notifications
You must be signed in to change notification settings - Fork 46
Description
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:

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:

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