-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Changelog automation #1434
Comments
Hi @ArthurSens. I would love to solve this issue for the upcoming LFX program. |
Hey @ArthurSens, I am quite interested in working upon this issue in the LFX program. |
Hey @ArthurSens, we could use GitHub's Automatic release notes generation feature itself, though we would have to assign labels to PRs and define a yaml file accordingly. Or do you have any other approach in mind? |
Hey folks, thanks for the interest :) Applications will be done through LFX mentoring website, so we'll have to wait for the official timeline to start working deeply on the proposal. This task alone is also quite small for the LFX program (around 3 months of work), so we're still working on other kinds of automation to add to the project idea (mostly around go version upgrades). With that said, I believe there's no problem on brainstorming high level ideas like you're doing :)
The Github's automatic release notes that I know dump the whole commit history between two releases, and that includes non-user-facing changes. Did they change anything recently that takes PR labels into consideration (and possibly a yaml file?)? |
Hey @ArthurSens maybe we can use some shell scripting to get hold of the file changes in the PR (using |
Yes, we can create a release.yml file, in which we can specify the PRs with specific labels to exclude from release notes or we can also specify labels to include them under certain categories.
|
Hello @ArthurSens,
I would appreciate any advice and further improvements on this and since this lies in my domain of knowledge, I would love to take this up in LFX'24 spring term. |
Hey @ArthurSens @kakkoyun , I have submitted my application for this project including possible implementation for the same. Will be grateful if you take a look at it as I would love to work with Prometheus in this mentorship as it strongly aligns with my interest. |
Hi everybody, I can confirm that we've received the applications :) I understand this is of great interest to all applicants, but please keep the timeline in mind. The application results will be announced on February 27th |
On every new release, we need to provide a list of changes that made it into the release. This log of changes is maintained in the CHANGELOG.md file.
Updating the Changelog file requires manual effort from maintainers, it demands searching through commit history, analyzing which PRs had user-facing changes, and which PRs hadn't, writing clear messages describing the change, etc.
This whole process could receive some improvements through automation.
This issue concerns researching, proposing, and implementing the Changelog automation for client_golang. The final goal is not to require manual effort from maintainers to go through a big list of commits and hand-picking changelog entries.
Related:
https://github.com/googleapis/release-please
xref: cncf/mentoring#1120
The text was updated successfully, but these errors were encountered: