skills.rest
HabibTorjmen
HabibTorjmenCOMMUNITY
Explore all skills by this author →
GitHub

updating-changelog

Generate changelog and migration-note entries from git diff next...HEAD.

Updated May 14, 2026
Search Tags:#changelog#documentation#breaking changes#release notes#git diff#migration notes#node operators
One-click install
npx skills add https://github.com/HabibTorjmen/Blockchain --skill updating-changelog-habibtorjmen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: updating-changelog
Source: https://github.com/HabibTorjmen/Blockchain/tree/main/aztec-packages/.claude/skills/updating-changelog
Command: npx skills add https://github.com/HabibTorjmen/Blockchain --skill updating-changelog-habibtorjmen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents contract and node release documentation from getting out of sync by automatically turning branch differences into well-formatted, reviewable changelog and migration-note entries.

Core Features & Use Cases

  • Analyzes branch changes relative to next to identify breaking changes, new features, deprecations, and configuration-related updates.
  • Drafts entries in the correct target files for both migration notes and operator/contract developer changelog pages, following existing formatting conventions.
  • Guides migration documentation by translating CLI flag/environment/config changes into before/after guidance that’s easy to review in a PR.

Quick Start

Ask the AI to update the changelog by analyzing next...HEAD and preparing formatted entries for the migration notes and the appropriate docs/docs-operate/operators/reference/changelog/v{major}.md file for contract developers and node operators.

Frequently Asked Questions about updating-changelog

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

FAQPage Schema
How do I generate changelog entries from a git diff before merging a release branch?▼

Generating changelog entries from a git diff involves analyzing branch differences like next...HEAD to identify breaking changes and new features, then drafting formatted documentation entries for review before updating the target markdown files.

What is the best way to document migration notes for breaking changes in release notes?▼

Documenting migration notes for breaking changes requires translating CLI flag, environment, or configuration modifications into clear before and after guidance that node operators and contract developers can easily review during a PR.

How do I keep release notes and documentation in sync with my current branch changes?▼

Keeping release notes in sync with branch changes prevents outdated documentation by automatically turning version differences into reviewable changelog and migration-note entries that match the formatting conventions of existing files.

Does generating migration notes require reading version targets from configuration files?▼

Generating migration notes does require reading version targets from configuration files like .release-please-manifest.json to ensure the drafted changelog entries align with the correct release version and destination markdown paths.

Can I automatically categorize deprecations and new features when updating changelog documentation?▼

Automatically categorizing deprecations and new features when updating changelog documentation is achieved by running a detailed git diff analysis between the next branch and HEAD to separate configuration impacts from standard updates.

Related Skills

Explore More Product & Management Skills→
AztecProtocolAztecProtocol
449

updating-changelog

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

Official
Intermediate
fxfx
8

update-description

Generate release-note summaries for GitHub Releases from changelog and PR bodies.

Community
Advanced
fabioc-alohafabioc-aloha

extension-versioning

Manage semantic versioning and CHANGELOG formatting for VS Code extensions.

Community
Intermediate
michael-conradmichael-conrad

changelog-generator

Generates categorized changelogs and release notes from git commit histories.

Community
Intermediate