py-changelog

Update release-history.rst changelog sections from git history.

Updated Apr 25, 2022
One-click install
npx skills add https://github.com/MacHu-GWU/afwf_github-project --skill py-changelog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: py-changelog
Source: https://github.com/MacHu-GWU/afwf_github-project/tree/main/.claude/skills/py-changelog
Command: npx skills add https://github.com/MacHu-GWU/afwf_github-project --skill py-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains the release-history.rst changelog for a Python project, aligning the target version with git history and keeping the backlog intact.

Core Features & Use Cases

  • Auto-synchronize the next release section with new commits and tags.
  • Generate clear, user-facing release notes from git history for the upcoming version.
  • Validate formatting against the project's RST conventions and ensure the backlog is preserved.

Quick Start

Run the changelog assistant to update the next release section in release-history.rst using the repository's latest tag.

Frequently Asked Questions about py-changelog

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

FAQPage Schema
How do I generate release notes from git history for a Python package?

You can generate release notes by reading the latest git tag, collecting commit messages since that tag, and auto-synchronizing the next release section in your changelog with those new commits.

How do I automate changelog updates for an upcoming Python release?

Automate changelog updates by deriving changes from git history and updating the target version section in release-history.rst, which aligns the new release notes while keeping the backlog intact.

Can I validate RST formatting for my Python release notes automatically?

Yes, you can validate RST formatting by checking the generated changelog content against your project's RST conventions, ensuring the output conforms to formatting standards before publishing.

Does this changelog automation work with existing release-history.rst backlogs?

Yes, the automation works with existing backlogs by updating the target release section with new commits and tags while explicitly preserving the remaining backlog content in the RST file.

What is the best way to prepare RST release notes before tagging a Python package?

The best way to prepare RST release notes is to run a changelog assistant that extracts commit messages since the latest tag, populates the next version section, and validates the RST formatting.

Why does my changelog need to read the latest git tag for Python release automation?

Reading the latest git tag is required to accurately collect the correct range of commit messages, ensuring the changelog only captures new changes designated for the upcoming package version.