Filetered hotfix prs from release notes #3738
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the release notes generation script to exclude hotfix pull requests from the generated release notes.
- Adds the chalk dependency for console output styling
- Filters out PRs labeled as hotfix with an accompanying console log message
- Preserves the sorting and mapping of the PR data
Comment on lines
50
to
56
| prs => _.filter(prs, pr => { | ||
| const isHotfix = pr.labels.some(label => label.name === 'hotfix'); | ||
| if (isHotfix) { | ||
| console.log(chalk.bgYellow.black(`PR ${pr.number} is a hotfix and was excluded for the release notes.`)); | ||
| } | ||
| return !isHotfix; | ||
| }), |
There was a problem hiding this comment.
[nitpick] Consider separating the logging from the filtering logic to better adhere to the single-responsibility principle; logging inside the filter function can lead to unexpected side effects if the collection is processed multiple times.
Suggested change
| prs => _.filter(prs, pr => { | |
| const isHotfix = pr.labels.some(label => label.name === 'hotfix'); | |
| if (isHotfix) { | |
| console.log(chalk.bgYellow.black(`PR ${pr.number} is a hotfix and was excluded for the release notes.`)); | |
| } | |
| return !isHotfix; | |
| }), | |
| prs => { | |
| // Log hotfix PRs | |
| prs.forEach(pr => { | |
| if (pr.labels.some(label => label.name === 'hotfix')) { | |
| console.log(chalk.bgYellow.black(`PR ${pr.number} is a hotfix and was excluded for the release notes.`)); | |
| } | |
| }); | |
| // Filter out hotfix PRs | |
| return _.filter(prs, pr => !pr.labels.some(label => label.name === 'hotfix')); | |
| }, |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Changed release notes generation script to ignore hot fixed prs.
Changed release notes generation so it will take hotfix prs when generating a patch release release notes.
Changelog
Infra - release notes generation script now excludes hot fixed prs.
Additional info
MADS-4718