Skip to content

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
Closed
Show file tree
Hide file tree
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
181 changes: 0 additions & 181 deletions .github/scripts/generate_release_notes.py

This file was deleted.

47 changes: 0 additions & 47 deletions .github/workflows/generate-release-notes.yml

This file was deleted.

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"
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"format": "format-files -i -style=file",
"format:verify": "format-files -i -style=file -verify",
"postinstall": "yarn build",
"release-notes": "yarn workspace @rnw-scripts/generate-release-notes release-notes",
"spellcheck": "npx cspell",
"test": "lage test --verbose --passWithNoTests",
"validate-overrides": "react-native-platform-override validate"
Expand Down
1 change: 1 addition & 0 deletions packages/@rnw-scripts/generate-release-notes/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
release_notes.md
43 changes: 43 additions & 0 deletions packages/@rnw-scripts/generate-release-notes/ReadMe.md
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.
Loading