-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Automate Creation of Release Notes with yarn script #14932
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
Conversation
…14931) * Initial plan * Add @rnw-scripts/generate-release-notes package with updated version and dates Co-authored-by: anupriya13 <[email protected]> * Update package.json with proper repository info and improve .gitignore Co-authored-by: anupriya13 <[email protected]> * Improve commit summaries by extracting release notes from PR descriptions Co-authored-by: anupriya13 <[email protected]> * Add PR inclusion filtering and Microsoft Reviewers cleanup logic Co-authored-by: anupriya13 <[email protected]> * update logic * Improve categorization logic based on PR Type of Change section Co-authored-by: anupriya13 <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: anupriya13 <[email protected]>
satkh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
packages/@rnw-scripts/generate-release-notes/generate-release-notes.js
Outdated
Show resolved
Hide resolved
iamAbhi-916
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, lets cross check manually for 0.80 release if any tweaks are required
Already tested with 0.80 start and end date commits, if we see any improvements that can be done here can be taken as enhancement in future PRs. Merging now. |
sharath2727
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with small nits.
| // Extract the next line or paragraph after the marker | ||
| const lines = afterMarker.split('\n').map(line => line.trim()).filter(line => line.length > 0); | ||
|
|
||
| if (lines.length === 0) return false; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "==" ?
| const marker = 'Should this change be included in the release notes:'; | ||
| const markerIndex = prDescription.indexOf(marker); | ||
|
|
||
| if (markerIndex === -1) return true; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
return false?
Description
Type of Change
Why
To save us some time when generating release notes.
Estimated time to generate release notes now after this script will be less than 30 mins.!!!
Resolves #14906
What
What changes were made to the codebase to solve the bug, add the functionality, etc. that you specified above.
This script does these tasks:
Steps to follow
1. Set up your personal access token
repo (full control of private repositories)
or at least repo:status, repo_deployment, public_repo (for public repos)
2. Set variables as params and run "yarn release-notes"
3. You will see a release-notes.md file generated at packages@rnw-scripts\generate-release-notes\release_notes.md which will have all the data you need.
4. Verify the release notes generated from all commits section and delete the "all commits" section after validation
Screenshots
Add any relevant screen captures here from before or after your changes.
automate.0.80.mp4
Testing
If you added tests that prove your changes are effective or that your feature works, add a few sentences here detailing the added test scenarios.
Optional: Describe the tests that you ran locally to verify your changes.


Tested locally and attached video
Changelog
Should this change be included in the release notes: no
Add a brief summary of the change to use in the release notes for the next release.