Skip to content

Automate Release Notes Creation #14675

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

Merged

Conversation

anupriya13
Copy link
Contributor

@anupriya13 anupriya13 commented May 15, 2025

Worked automating the process of creating release notes so that we don't have to manually copy paste the commits.

Latest run 0.79: https://github.com/microsoft/react-native-windows/actions/runs/15104180584

Steps

For every release, this PR can be referred.

  1. Update start and end dates and release number default value on '.github/workflows/generate-release-notes.yml' file and commit it here
  2. Go to Github Actions tab, the workflow would be visible running after your commit
  3. Once the workflow is completed download the artifact release_notes.md file
  4. Update the Summary for each PR if needed and regroup PRs [copy-paste to correct group]

Format

Explanation. [PRName (#11168) · microsoft/react-native-windows@aaaaaaa (github.com)](link)

Example:

Refer: https://github.com/microsoft/react-native-windows/releases/tag/react-native-windows_v0.76.0

What

Fetches commit from start and end date range, ignores bots and publish the release notes to artifacts.

Artifact Latest 0.79:
https://github.com/microsoft/react-native-windows/actions/runs/15104180584/artifacts/3148688188

Updated this job to trigger on every release tag/ *-stable branches PRs with manual insertion of start and end date or update the default values from script.

Microsoft Reviewers: Open in CodeFlow

@anupriya13 anupriya13 changed the title [Draft][Testing] Automate Release Notes Automate Release Notes May 15, 2025
@anupriya13 anupriya13 changed the title Automate Release Notes Automate Release Notes Creation May 15, 2025
@TatianaKapos
Copy link
Contributor

TatianaKapos commented May 15, 2025

I think this a great starting off point and will definitely save some time!

Keep in mind that you will still need to manually go through each commit here and add an Summary/Explanation section and remove PRs that aren't useful to customers (ie anything to do with testing with our repo, experimental features that are still in progress, ect).

Also would this make more sense to just have as an internal script instead of running every time in the pipeline?

@TatianaKapos
Copy link
Contributor

TatianaKapos commented May 15, 2025

Feel free to look at previous release notes to get a feel! Notice the explanation/summary section will sometimes differ from the PR name.
https://github.com/microsoft/react-native-windows/releases/tag/react-native-windows_v0.78.0
https://github.com/microsoft/react-native-windows/releases/tag/react-native-windows_v0.77.0
https://github.com/microsoft/react-native-windows/releases/tag/react-native-windows_v0.76.0

You'll also still have to manually add any PRs backported into the stable branch before the release goes out

Copy link
Contributor

@TatianaKapos TatianaKapos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for this to be in the pipeline?

I feel like this would be most useful as an internal script such as "integrate-rn", especially if you're going to have to manually edit the workflow to get it to run and will only need to be run once in a stable branch

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Author Feedback The issue/PR needs activity from its author (label drives bot activity) label May 19, 2025
@anupriya13
Copy link
Contributor Author

anupriya13 commented May 20, 2025

@TatianaKapos Makes sense, will turn it to a draft PR for reference only. Also, it's not in the Azure pipelines, it's in the GitHub Actions.

@microsoft-github-policy-service microsoft-github-policy-service bot added Needs: Attention 👋 An issue that had been tagged "Needs: Author Feedback" has received activity (label applied by bot) and removed Needs: Author Feedback The issue/PR needs activity from its author (label drives bot activity) labels May 20, 2025
@anupriya13 anupriya13 marked this pull request as draft May 20, 2025 01:45
@anupriya13 anupriya13 force-pushed the user/anuverma/automate_releasenotes branch from 1ba3c44 to 6511212 Compare May 30, 2025 06:08
@anupriya13 anupriya13 force-pushed the user/anuverma/automate_releasenotes branch from 6f41562 to 78d450a Compare May 30, 2025 07:08
@anupriya13
Copy link
Contributor Author

anupriya13 commented May 30, 2025

@TatianaKapos I have updated the script to only run whenever this '.github/workflows/generate-release-notes.yml' file is updated ie when we change the start and end date / release number

@anupriya13 anupriya13 marked this pull request as ready for review May 30, 2025 07:25
@anupriya13 anupriya13 requested review from TatianaKapos, iamAbhi-916 and a team May 30, 2025 07:30
@anupriya13 anupriya13 force-pushed the user/anuverma/automate_releasenotes branch 2 times, most recently from 357eb24 to be8fe0a Compare May 30, 2025 07:53
Copy link
Contributor

@iamAbhi-916 iamAbhi-916 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@TatianaKapos
Copy link
Contributor

TatianaKapos commented May 30, 2025

It still makes the most sense to me to have this as an internal script like "yarn integrate" that takes in the date parameters in the CLI, then you don't have to run the script on github actions everytime you want to update it. But if that's a non-trivial change, I am fine merging this in.

@anupriya13
Copy link
Contributor Author

@TatianaKapos Commented "on" trigger for now

Copy link
Contributor

@TatianaKapos TatianaKapos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! future work to turn this into a internal script

@anupriya13 anupriya13 merged commit 420857a into microsoft:main May 31, 2025
59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Release Process Needs: Attention 👋 An issue that had been tagged "Needs: Author Feedback" has received activity (label applied by bot) Workstream: Releases and Integrations Keep RNW current with RN releases.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants