release-notes

Update Azure SDK for Java CHANGELOG.md and README.md from GitHub PR diffs.

2.6k|2.2k|Updated Dec 6, 2011
One-click install
npx skills add https://github.com/Azure/azure-sdk-for-java --skill release-notes-azure
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/.workflow_docs/release-notes
Command: npx skills add https://github.com/Azure/azure-sdk-for-java --skill release-notes-azure

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of updating release notes, changelogs, and README files for Azure SDK for Java packages, ensuring consistency and saving developers significant time.

Core Features & Use Cases

  • Automated Documentation Updates: Generates or updates CHANGELOG.md and README.md based on GitHub Pull Requests.
  • PR Analysis: Parses PR details (title, body, file changes) to identify relevant updates for documentation.
  • Conflict Detection: Checks for existing entries in documentation to prevent duplication and prompts for user clarification.
  • Use Case: After merging a PR that introduces new features and fixes bugs in the azure-storage-blob Java SDK, use this Skill to automatically update its CHANGELOG.md and README.md with the changes from the PR.

Quick Start

Use the release-notes skill to update the changelog and readme for PR number 1234.

Frequently Asked Questions about release-notes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate updating Azure SDK release notes from a GitHub PR?

To automate updating Azure SDK release notes from a GitHub PR, use a tool that parses PR diffs to identify changes in classes and methods, then appends the extracted information to CHANGELOG.md and README.md. This Skill analyzes GitHub PR details to automate exactly that process.

Can I generate changelogs for Azure SDK for Java packages automatically?

Yes, you can generate changelogs for Azure SDK for Java packages automatically. This Skill analyzes merged GitHub Pull Requests to identify changes in classes, methods, and service versions, appending new information to your package's documentation following strict formatting rules.

Do I need gh CLI authentication to generate SDK documentation?

Yes, you need gh CLI authentication to generate SDK documentation using this Skill. It relies on the GitHub CLI to fetch PR details, parse file changes, and operate on package root directories to update your changelog and readme files accurately.

What's the best way to prevent duplicate entries in SDK changelogs?

The best way to prevent duplicate entries in SDK changelogs is to use a tool with built-in conflict detection. This Skill checks existing documentation entries before appending new information from GitHub PRs, prompting for user clarification if duplicates are found.

How does PR diff analysis work for updating SDK documentation?

PR diff analysis for updating SDK documentation works by parsing GitHub PR titles, bodies, and file changes. This Skill identifies specific updates in classes, methods, and service versions from the diff, ensuring only relevant changes are appended to the changelog and readme.

Are there limitations when updating CHANGELOG.md for Azure SDK packages?

Limitations when updating CHANGELOG.md include requiring operation on package root directories and strict adherence to formatting rules. This Skill is specialized for Azure SDK for Java packages and depends on gh CLI authentication to function correctly.