release-notes

Release Notes Skill

Update CHANGELOG.md and/or README.md for an Azure SDK for Java package using a GitHub PR as the source of truth.

Prerequisites

• gh CLI authenticated (gh auth status).
• The current working directory must be the package root (where CHANGELOG.md and README.md live).

Inputs

Ask the user for any missing inputs before proceeding:

Input	Required	Description
PR URL or number	Yes	GitHub PR to use as the source of changes.
Package directory	No	Defaults to cwd. Override if the user specifies a different package.
Scope	No	changelog, readme, or both (default: both).

Step 1 — Gather PR information

Use gh to collect the data you need. The diff may be too large for gh pr diff; fall back to the files API.

# PR metadata
gh pr view <number> --json title,body

# File list with status (added/modified/removed/renamed)
gh api repos/{owner}/{repo}/pulls/<number>/files --paginate \
  --jq '.[] | .status + " " + .filename'

# Renamed files (old → new)
gh api repos/{owner}/{repo}/pulls/<number>/files --paginate \
  --jq '.[] | select(.status == "renamed") | "\(.previous_filename) -> \(.filename)"'

# Patch for a specific file (when you need detail)
gh api "repos/{owner}/{repo}/pulls/<number>/files?per_page=100" \
  --jq '.[] | select(.filename | test("<pattern>")) | .patch'

Collect:

• Added, removed, and renamed model/enum classes.
• Changes to client classes (method renames, new methods, removed methods).
• Changes to *ServiceVersion.java (version string changes).
• Changes to *ClientBuilder.java (base URL, authentication, new builder methods).
• Changes to module-info.java (transitive exports, new requires).
• Changes to customization files.
• New or modified samples.

Step 2 — Check for existing entries

Before writing anything, read the current CHANGELOG.md and README.md (if in scope) in full and compare their content against the changes you collected in Step 1.