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

chore: categorize dependency updates and other changes in auto-generated release notes #1515

Merged
merged 2 commits into from
May 6, 2024

Conversation

pddg
Copy link
Contributor

@pddg pddg commented May 4, 2024

Release note of grafana-operator seems to be generated by GitHub's auto-generation feature.
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

It is hard for us to read large number of changes that may contains important changes.
Special attention should be paid when important changes are mixed in with the large number of dependency change logs.

Fortunately, the PRs automatically generated by dependabot are labeled dependencies. This could be used to categorize the list of changes in the release notes to reduce the burden on the user.
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options

The release notes should now appear as follows:

## What's Changed

### Changes

- chore: some update by @~~  in #123
- some important changes by @~~ in #456

### Dependencies

- chore(deps): bump ~~ by @dependabot in #789

The category titles are tentative, so if you have a good one, please let me know.

@CLAassistant
Copy link

CLAassistant commented May 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@weisdd weisdd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pddg thanks for the PR!

Indeed, it makes sense to categorize changes in release descriptions. It's actually something that we briefly discussed (internally) quite a while ago, just have never implemented it ourselves due to being busy with other things.

As for the titles, I think we can leave as is for now. Later, if we start adding more labels to PRs at some point, we can further improve the layout / titles.

Let's see what other maintainers think. - We'll probably discuss it on Monday.

@theSuess theSuess enabled auto-merge May 6, 2024 09:06
@theSuess theSuess merged commit 28bbb17 into grafana:master May 6, 2024
10 checks passed
@pddg pddg deleted the categorize-changes branch May 7, 2024 00:31
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

Successfully merging this pull request may close these issues.

4 participants