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

[PM-14880] Add release notes config #4295

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
changelog:
exclude:
labels:
- ignore-for-release
- tests-only
categories:
- title: ':tada: Exciting New Features'
labels:
- '*'
exclude:
authors:
- renovate[bot]
Comment on lines +7 to +12
Copy link
Member

Choose a reason for hiding this comment

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

๐Ÿค” Shouldn't we exclude the labels of the other categories here? So e.g. a PR labeled with bug is not listed as an exciting new feature.

Copy link
Member Author

@vvolkgang vvolkgang Nov 13, 2024

Choose a reason for hiding this comment

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

This applies to the other comments too, all of these were put in place to test how their implementation reacts to misconfiguration. I'll update the description to note that.

- title: ๐Ÿ› Bug Fixes
labels:
- bug
- title: ':mega: Community Contributions Highlight'
labels:
- community-pr
- title: โšก Performance
labels:
- performance
- title: ๐Ÿ‘’ Dependencies & Housekeeping
authors:
- renovate[bot]
Comment on lines +23 to +24
Copy link
Member

Choose a reason for hiding this comment

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

โš ๏ธ From what I can see in the docs authors is only available in exclude section => changelog.categories[*].exclude.authors; so I think this config won't work or do anything.
Additionally, maybe we could have PRs created by renovate[bot] automatically have one of the labels listed below so to be added to this category.

labels:
- ci/cd
- chore
- tests-only
- refactor
- tests-only
Comment on lines +28 to +30
Copy link
Member

Choose a reason for hiding this comment

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

โ›๏ธ tests-only is repeated.
๐Ÿค” I see tests-only excluded in the exclude top section, which one takes precedence?