Create CHANGELOG.md for easier communication of library changes, especially possible breaking changes. #833
Conversation
ArthurSens
left a comment
There was a problem hiding this comment.
Hey, thanks for the effort to make things better!
I believe we shouldn't be changing our release process from the GitHub UI; I believe the UI provides a better experience and is even less error-prone.
Regarding the Changelog, I don't know if bots like Renovate/Dependabot look for files called CHANGELOG.md. Could you share where you've read it?
| There is no automated process for cutting a release in `prometheus/common`. A manual release using GitHub's release feature via [this link](https://github.com/prometheus/prometheus/releases/new) is the best way to go. The tag name must be prefixed with a `v` e.g. `v0.53.0` and then you can use the "Generate release notes" button to generate the release note automagically ✨. No need to create a discussion or mark it a pre-release, please do mark it as the latest release if needed. | ||
| There is no automated process for cutting a release in `prometheus/common`. | ||
| The primary trigger for announcing a release is pushing a new version tag. |
There was a problem hiding this comment.
Actually, I think we don't want to do that. We shouldn't be pushing tags manually; GitHub UI is good enough for that, and it ensures we don't push tags unintentionally 🤔
There was a problem hiding this comment.
I'll clarify -- I just mean that the creation of the tag triggers releases, whether it's pushed or created by the UI
RELEASE.md
Outdated
| NOTE: As soon as the tag is pushed, many downstream projects will automatically create pull requests to update their dependency of prom/common. | ||
| Make sure the release is ready to go, with an updated changelog including notices of any breaking changes, before pushing a new tag. |
There was a problem hiding this comment.
Interesting, I think this is the root cause of our problems yesterday. Creating a release from the UI, without a pre-existing tag, will create this tag for us at the same time as the release is done.
I believe we shouldn't change this
There was a problem hiding this comment.
the root cause was I used a command that pushes all tags, and I assumed that my tags would be in sync with upstream. I did not consider that I would have local tags that had been deleted on the remote from an earlier cleanup
|
https://medium.com/globant/github-dependabot-042d61a5e8d6 "Automatic pull requests: Dependabot creates automatic pull requests whenever it finds new version updates. It creates pull requests with all the crucial details, such as release notes, change logs, and commits." |
|
We won't know for sure until we try doing the next release, but I bet it'll work. I copied the format of the prometheus/prometheus changelog, which seems to work |
c13448a to
328b0c7
Compare
…cially possible breaking changes. Signed-off-by: Owen Williams <owen.williams@grafana.com>
328b0c7 to
e9e8fe5
Compare
No description provided.