Seeking Input on Changelog Automation for Prometheus/client_golang

[Sachin Kumar Sahu]

Hello community!

I am Sachin Sahu, an undergraduate student from India, currently collaborating with Arthur Silva Sens and Kemal Akkoyun as an LFX mentee on the Prometheus/client_golang project.

We plan to work on the automation of changelog generation on client_golang and also intend to propose this enhancement to the broader Prometheus ecosystem.

Before proceeding, we are curious to know if there have been previous discussions or projects addressing similar automation efforts. Do you have any particular preferences or suggestions regarding previous discussions or projects addressing similar automation efforts? Are there any aspects you dislike, or any must-have features you'd like to see?

NOTE: This message was already sent on Slack, but I’m sending it on mailing list to reach out to those not on Slack. Here's the link to the Slack conversation for reference: https://cloud-native.slack.com/archives/C01AUBA4PFE/p1712237228094919

Your insights and feedback would be immensely valuable to us.

Thank you for your time and consideration!

Best regards,
Sachin

[Sachin Kumar Sahu]

Hey everyone,

Thank you for sharing your thoughts, Adam! I really love how release-please creates a release PR, and continues to update it as more pull requests are merged into the main branch.

Currently, release-please only grabs the PR title for the changelog. I was wondering if it can optionally include parts of the PR descriptions (specifically under the 'changelog entry' section, which we can define in the pull request template) in the changelog as well? This could greatly help us in highlighting user-facing changes.

I'd love to hear your thoughts on this and if anyone knows of a tool that provides similar functionality, it would be fantastic to explore.

Thank you!

~Sachin

On Sat, 6 Apr 2024 at 04:01, Adam Bernot <ber...@google.com> wrote:

Sachin,

We are also working in that direction with Conventional Commits and Release Please.

It ends up generating release PRs that include changelogs that look like this: https://github.com/GoogleCloudPlatform/prometheus-engine/pull/876

We still have some tweaking to do to get it working smoothly with our processes, but it seems promising. I am interested to hear what you come up with!

Adam Bernot Software Engineer ber...@google.com

--
You received this message because you are subscribed to the Google Groups "Prometheus Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to prometheus-devel...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/prometheus-developers/0e589f6a-7f37-4bc9-8d88-c60e9e9783c4n%40googlegroups.com.

[Adam Bernot]

Sachin,

We are also working in that direction with Conventional Commits and Release Please.

It ends up generating release PRs that include changelogs that look like this: https://github.com/GoogleCloudPlatform/prometheus-engine/pull/876

We still have some tweaking to do to get it working smoothly with our processes, but it seems promising. I am interested to hear what you come up with!

Adam Bernot Software Engineer ber...@google.com

On Fri, Apr 5, 2024 at 4:37 AM Sachin Kumar Sahu <sachink...@gmail.com> wrote:

--