Write release notes

Location

apps/docs/content/releases/

next.mdx

vX.Y.0.mdx

Process

1. Identify the release

gh release view v4.3.0

2. Find all PRs in the release

# Find commits between releases
git log v4.2.0..v4.3.0 --oneline --merges

# Or use gh to list PRs
gh pr list --state merged --base main --search "merged:2024-01-01..2024-02-01"

3. Fetch PR details

gh pr view <PR_NUMBER> --json title,body,labels,author

• ### Release notes

  section in PR body

• ### API changes

  section in PR body
• Labels indicating category (api, bugfix, improvement, etc.)
• Whether "breaking" appears in the PR

4. Find patch releases

gh release list | grep "v4.3"

git log v4.3.0..v4.3.1 --oneline --merges

5. Write the article

apps/docs/content/releases/vX.Y.0.mdx

1. Write the frontmatter with version, dates, and keywords
2. Write a 1-2 sentence introduction summarizing highlights
3. Create featured sections for major features and breaking changes
4. List API changes, improvements, and bug fixes
5. Add patch release sections if applicable
6. Add GitHub release links

6. Verify

• All significant PRs are represented
• PR links are correct and formatted properly
• Community contributors are credited
• Breaking changes are marked with 💥
• Sections are in the correct order

References

• Style guide: See

  ../shared/release-notes-guide.md

  for guidance on what a release notes article should contain and how to format it.