changelog-automation

Changelog Automation - Automated Changelog Generation Skill

Skill Overview

Changelog Automation is a skill for automatically generating project changelogs and release notes, following the Keep a Changelog standard format. It helps teams standardize commit messages and establish an efficient release workflow.

Applicable Scenarios

Open source project maintenance: When you need to automatically generate standardized changelogs from commits, PRs, and releases so users can clearly understand the changes in each version.

Team collaboration standardization: When a team needs to unify commit message formats, implement the conventional commits specification, and automatically convert commits into release notes.

CI/CD release automation: When you want to automatically generate release notes, manage semantic versions, and integrate with GitHub Releases or other publishing platforms as part of your continuous integration process.

Core Features

Automated changelog generation: Automatically generate structured changelogs from Git commit history, Pull Request labels, or release information. Supports the Keep a Changelog format and can organize entries by categories such as Added, Changed, Deprecated, Removed, Fixed, Security, etc.

Commit convention enforcement: Helps configure conventional commits or custom commit conventions, including integration with tools like commitlint and husky, ensuring commit messages are consistent and parseable.

Version management integration: Supports automatic semantic version increments and can work with tools like standard-version and semantic-release to achieve a fully automated workflow from code commits to releases.

Frequently Asked Questions

Which changelog formats does changelog-automation support?

The skill defaults to following the Keep a Changelog standard, which is widely used in the industry. It also supports customizing format templates according to team needs, including different categorization methods (e.g., Features, Bug Fixes), version number styles, and layout structures.

Can projects without commit history use this skill?

If a project does not have an available Git commit history, the automation capabilities will be limited. It is recommended to first establish a commit convention and start collecting change information from the next version. For existing projects, you can also manually compile historical version information and then begin automating from the current version.

How does changelog-automation integrate with CI/CD?

The skill supports integration with major CI/CD platforms such as GitHub Actions, GitLab CI, Jenkins, etc. It can automatically trigger changelog generation, update version numbers, create Git tags, and push to GitHub Releases or other publishing platforms during the release stage. For detailed configuration, refer to resources/implementation-playbook.md.