changelog-pyproject

Update CHANGELOG.md and pyproject.toml versions from commit history.

5|3|Updated Jun 18, 2024

Search Tags:#automation #changelog #release-management #pyproject #version-bump #software-release

Ready to run

npx skills add https://github.com/Unique-AG/ai --skill changelog-pyproject

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: changelog-pyproject
Source: https://github.com/Unique-AG/ai/tree/main/.claude/skills/changelog-pyproject
Command: npx skills add https://github.com/Unique-AG/ai --skill changelog-pyproject

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updates CHANGELOG.md and pyproject.toml version for releases. Use when the user wants to release changes, update the changelog, bump the version, or prepare a release.

Core Features & Use Cases

Identify changes from recent commits or context to generate changelog entries
Bump the version in pyproject.toml according to semantic changes or release policy
Prepare release summaries and ensure CHANGELOG.md and pyproject.toml are in sync for a clean release

Quick Start

Provide release context (e.g., a list of commits or changes) and run the skill to update the changelog and the pyproject version.

Frequently Asked Questions about changelog-pyproject

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

FAQPage Schema

How do I automate changelog generation and version bumps for a Python release?▼

To automate changelog generation and version bumps, you can use a skill that parses recent commit messages, applies semantic versioning rules, and edits CHANGELOG.md and pyproject.toml in place to prepare a clean release.

How does semantic version bumping work when updating pyproject.toml?▼

Semantic version bumping in pyproject.toml works by parsing commit history to identify the level of changes, applying the matching semantic version increment, and writing the updated version string directly into the configuration file.

Can I generate release notes directly from commit history?▼

Yes, you can generate release notes from commit history by parsing commit messages to identify changes and synthesizing those parsed entries into structured changelog entries within your CHANGELOG.md file.

What is the best way to keep CHANGELOG.md and pyproject.toml in sync for a release?▼

The best way to keep CHANGELOG.md and pyproject.toml in sync is to run an automated release workflow that updates both files simultaneously, applying the same semantic version bump and synthesized release notes in a single operation.

Do I need to manually write changelog entries when preparing a Python package release?▼

No, you do not need to manually write changelog entries when preparing a Python package release if you provide release context like a list of commits, allowing the automation to synthesize changelog entries from the commit history.