-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add a new "yarn release-notes" script to generate release notes #14720
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
Closed
anupriya13
wants to merge
7
commits into
microsoft:main
from
anupriya13:user/anuverma/yarnReleaseNotes
Closed
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7edba4b
Add a new "yarn release-notes" script to generate release notes
anupriya13 501b03f
format and lint fix
anupriya13 8ae9d34
Change files
anupriya13 52e94d8
Create ReadMe.md
anupriya13 8f0f6ff
Update ReadMe.md
anupriya13 090256a
Update yarn.lock to match package.json
anupriya13 c50f15f
Add "All Commits" Section
anupriya13 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
7 changes: 7 additions & 0 deletions
7
change/@rnw-scripts-generate-release-notes-6cbf3b31-93bb-44c9-91a0-284f2d6a73d3.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"type": "patch", | ||
"comment": "Add a new \"yarn release-notes\" script to generate release notes", | ||
"packageName": "@rnw-scripts/generate-release-notes", | ||
"email": "54227869+anupriya13@users.noreply.github.com", | ||
"dependentChangeType": "patch" | ||
} |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
release_notes.md |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
### Type of Change | ||
Automate release notes creation by adding a new yarn script. Automating the process of creating release notes so that we don't have to manually copy paste the commits. | ||
|
||
|
||
### Why | ||
To save us some time when generating release notes. Fetches commit from start and end date range, ignores bots and creates the release notes md file. It also categorizes the commits. Please cross-check the generated release-notes.md file and update it manually if required like regrouping commits or updating the Summary/Explanation for the PR commit. | ||
|
||
## Format | ||
|
||
`Explanation. [PRName (#11168) · microsoft/react-native-windows@aaaaaaa (github.com)](link)` | ||
|
||
### Steps to follow | ||
|
||
#### 1. Set up your personal access token | ||
|
||
- Go to GitHub and log in: https://github.com/ | ||
- Click on your profile picture (top-right corner), then click Settings | ||
- On the left sidebar, click Developer settings | ||
- Then click Personal access tokens > Tokens (classic) | ||
- Click Generate new token > Generate new token (classic) | ||
- Give it a name like "Release Notes Script" | ||
- Set an expiration (choose less than 90 days) | ||
- Under Scopes, select the permissions your script needs. For fetching commits and repo info, you typically need: | ||
repo (full control of private repositories) | ||
or at least repo:status, repo_deployment, public_repo (for public repos) | ||
- Click Generate token | ||
- Find the token you're using (whichever token you created). | ||
- You should see a message or option to "Grant access to your organization" or "Authorize SAML SSO" for your token. | ||
- Click that button to authorize the token with the organization. | ||
- Copy the generated token | ||
|
||
#### 2. Set env variables at root of the repo | ||
|
||
``` | ||
set GITHUB_TOKEN=<your-personal-access-token> | ||
set RELEASE_TAG=0.79.0 | ||
set START_DATE=2025-05-06 | ||
set END_DATE=2025-05-30 | ||
|
||
``` | ||
#### 3. Run "`yarn release-notes`" at the root of the repo | ||
|
||
#### 4. 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. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.