updating-changelog

Generate changelog drafts by analyzing git diffs between next and HEAD.

449|615|Updated Feb 20, 2023

Search Tags:#changelog #documentation #update #git-diff #PR-prep #migration-notes

Ready to run

npx skills add https://github.com/AztecProtocol/aztec-packages --skill updating-changelog

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: updating-changelog
Source: https://github.com/AztecProtocol/aztec-packages/tree/main/.claude/skills/updating-changelog
Command: npx skills add https://github.com/AztecProtocol/aztec-packages --skill updating-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of changelog drafts by analyzing branch changes relative to the 'next' branch.

Core Features & Use Cases

Analyze git diffs between next and HEAD to generate draft changelog entries.
Update migration notes and release notes for contract developers and node operators.
Use case: When preparing a PR that introduces breaking changes, run this skill to generate a structured changelog draft and apply it to docs.

Quick Start

Run the updating-changelog skill to generate a draft changelog by comparing the current branch to next and applying notes to the appropriate documentation files.

Frequently Asked Questions about updating-changelog

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

FAQPage Schema

How do I generate a changelog draft from git diff for PR preparation?▼

To generate a changelog draft from git diff, the skill analyzes branch changes relative to the next branch using git diff next...HEAD. It then structures the detected changes into draft entries for editors to review and publish.

How does automated changelog generation from branch changes work?▼

Automated changelog generation works by reading .release-please-manifest.json to determine target documentation files, then comparing the current branch to next using git diff. It drafts structured entries based on the differences found.

Can I use this to update migration notes for contract developers and node operators?▼

Yes, you can use this skill to update migration notes and release documentation for contract developers and node operators. It drafts structured entries from branch changes and applies them to the appropriate documentation files.

What's the best way to document breaking changes in a release?▼

The best way to document breaking changes is to run this skill before finalizing a PR. It analyzes the git diff between your branch and next, generating a structured changelog draft that covers the breaking changes for review.

Do I need a .release-please-manifest.json file to generate changelog drafts?▼

Yes, you need a .release-please-manifest.json file in your repository. The skill reads this manifest to determine the target documentation files where the drafted changelog entries and migration notes will be applied.

Are generated changelog entries published automatically to documentation?▼

No, generated changelog entries are not published automatically. The skill creates a draft from the git diff analysis that editors must then review and publish to the appropriate documentation files.