Add configuration for automated release notes #2047
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
mongodb-drivers-pr-bot bot added the review-priority-low 
API Change ReportNo changes found! |
| categories: | ||
| - title: Breaking Changes 🛠 | ||
| labels: | ||
| - breaking-change |
There was a problem hiding this comment.
Are we going to start labeling pull requests? Should we create a JIRA automation rule to label pull requests bug, enhancement, breaking-change? If not, perhaps we should update the pull request template to note this as a TODO: https://github.com/mongodb/mongo-go-driver/blob/master/docs/pull_request_template.md
There was a problem hiding this comment.
If we think that kind of labelling is useful, we should start doing it. In the end, it's a team decision. Without these categories, the changelog is presented as a single list, which would also fine for the beginning.
prestonvasquez approved these changes May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a config file for automated release notes. We exclude all pull requests from the PR bot to ensure the changelog doesn't get flooded with merge-up pull requests. Also excluded are submodule dependency updates (e.g. for spec tests) and anything we tag with a (yet to create)
ignore-for-releaselabel.I've also included a sample categorisation into breaking changes, new features, fixes, and other changes. We can customise these based on our preferences - the current categorisation is simply what we use for PHP's Laravel integration.