Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.
Patterns and tools for automating changelog generation, release notes, and version management following industry standards.
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- New feature X
## [1.2.0] - 2024-01-15
### Added
- User profile avatars
- Dark mode support
### Changed
- Improved loading performance by 40%
### Deprecated
- Old authentication API (use v2)
### Removed
- Legacy payment gateway
### Fixed
- Login timeout issue (#123)
### Security
- Updated dependencies for CVE-2024-1234
[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
| Type | Description | Changelog Section |
|------|-------------|-------------------|
| feat | New feature | Added |
| fix | Bug fix | Fixed |
| docs | Documentation | (usually excluded) |
| style | Formatting | (usually excluded) |
| refactor | Code restructure | Changed |
| perf | Performance | Changed |
| test | Tests | (usually excluded) |
| chore | Maintenance | (usually excluded) |
| ci | CI changes | (usually excluded) |
| build | Build system | (usually excluded) |
| revert | Revert commit | Removed |
MAJOR.MINOR.PATCH
MAJOR: Breaking changes (feat! or BREAKING CHANGE)
MINOR: New features (feat)
PATCH: Bug fixes (fix)
Six methods are available depending on language and automation level. For full configuration details, see references/tool-configs.md.
| Method | Stack | Best For | |--------|-------|----------| | 1. Conventional Changelog | Node.js (commitlint + husky) | Teams enforcing commit standards at the hook level | | 2. standard-version | Node.js | Semver bumping + changelog in one command | | 3. semantic-release | Node.js (fully automated) | CI-driven releases with zero manual steps | | 4. GitHub Actions | YAML workflow | Any stack — CI-native release pipelines | | 5. git-cliff | Rust (fast, template-based) | Custom changelog formats with Tera templates | | 6. commitizen | Python | Python projects needing interactive commit tooling |
Quick start for the most common case (semantic-release in CI):
npm install -D semantic-release @semantic-release/changelog @semantic-release/git
npx semantic-release
See references/tool-configs.md for complete configs for all six methods.
For GitHub Release and Internal Release Note templates, see references/templates-and-examples.md.
For annotated examples covering scopes, issue references, breaking changes, and multi-paragraph bodies, see references/templates-and-examples.md.
! or footernpx skills add Data-Wise/changelog-automation下载完整 Skill 目录，包含 SKILL.md 及所有相关文件
Search for places (restaurants, cafes, etc.) via Google Places API proxy on localhost.
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Start voice calls via the OpenClaw voice-call plugin.
Notion API for creating and managing pages, databases, and blocks.
Gemini CLI for one-shot Q&A, summaries, and generation.
Category:developer