changelog-generator
Changelog Generator
- License 许可
- MIT
- 所属仓库
- kalash33/kstack
- 最近更新
- 2026-05-20
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- changelog-generator
- description
- Changelog Generator
02 资源文件 6
- 参考文档README.md1.1 KB
- 参考文档references/changelog-formatting-guide.md316 B
- 参考文档references/ci-integration.md509 B
- 参考文档references/monorepo-strategy.md1.3 KB
- 脚本scripts/commit_linter.py3.9 KB
- 脚本scripts/generate_changelog.py7.7 KB
03 SKILL.md 正文
Changelog Generator
Tier: POWERFUL
Category: Engineering
Domain: Release Management / Documentation
Overview
Use this skill to produce consistent, auditable release notes from Conventional Commits. It separates commit parsing, semantic bump logic, and changelog rendering so teams can automate releases without losing editorial control.
Core Capabilities
- Parse commit messages using Conventional Commit rules
- Detect semantic bump (
major,minor,patch) from commit stream - Render Keep a Changelog sections (
Added,Changed,Fixed, etc.) - Generate release entries from git ranges or provided commit input
- Enforce commit format with a dedicated linter script
- Support CI integration via machine-readable JSON output
When to Use
- Before publishing a release tag
- During CI to generate release notes automatically
- During PR checks to block invalid commit message formats
- In monorepos where package changelogs require scoped filtering
- When converting raw git history into user-facing notes
Key Workflows
1. Generate Changelog Entry From Git
python3 scripts/generate_changelog.py \
--from-tag v1.3.0 \
--to-tag v1.4.0 \
--next-version v1.4.0 \
--format markdown
2. Generate Entry From stdin/File Input
git log v1.3.0..v1.4.0 --pretty=format:'%s' | \
python3 scripts/generate_changelog.py --next-version v1.4.0 --format markdown
python3 scripts/generate_changelog.py --input commits.txt --next-version v1.4.0 --format json
3. Update CHANGELOG.md
python3 scripts/generate_changelog.py \
--from-tag v1.3.0 \
--to-tag HEAD \
--next-version v1.4.0 \
--write CHANGELOG.md
4. Lint Commits Before Merge
python3 scripts/commit_linter.py --from-ref origin/main --to-ref HEAD --strict --format text
Or file/stdin:
python3 scripts/commit_linter.py --input commits.txt --strict
cat commits.txt | python3 scripts/commit_linter.py --format json
Conventional Commit Rules
Supported types:
feat,fix,perf,refactor,docs,test,build,ci,choresecurity,deprecated,remove
Breaking changes:
type(scope)!: summary- Footer/body includes
BREAKING CHANGE:
SemVer mapping:
- breaking ->
major - non-breaking
feat->minor - all others ->
patch
Script Interfaces
python3 scripts/generate_changelog.py --help- Reads commits from git or stdin/
--input - Renders markdown or JSON
- Optional in-place changelog prepend
- Reads commits from git or stdin/
python3 scripts/commit_linter.py --help- Validates commit format
- Returns non-zero in
--strictmode on violations
Common Pitfalls
- Mixing merge commit messages with release commit parsing
- Using vague commit summaries that cannot become release notes
- Failing to include migration guidance for breaking changes
- Treating docs/chore changes as user-facing features
- Overwriting historical changelog sections instead of prepending
Best Practices
- Keep commits small and intent-driven.
- Scope commit messages (
feat(api): ...) in multi-package repos. - Enforce linter checks in PR pipelines.
- Review generated markdown before publishing.
- Tag releases only after changelog generation succeeds.
- Keep an
[Unreleased]section for manual curation when needed.
References
- references/ci-integration.md
- references/changelog-formatting-guide.md
- references/monorepo-strategy.md
- README.md
Release Governance
Use this release flow for predictability:
- Lint commit history for target release range.
- Generate changelog draft from commits.
- Manually adjust wording for customer clarity.
- Validate semver bump recommendation.
- Tag release only after changelog is approved.
Output Quality Checks
- Each bullet is user-meaningful, not implementation noise.
- Breaking changes include migration action.
- Security fixes are isolated in
Securitysection. - Sections with no entries are omitted.
- Duplicate bullets across sections are removed.
CI Policy
- Run
commit_linter.py --stricton all PRs. - Block merge on invalid conventional commits.
- Auto-generate draft release notes on tag push.
- Require human approval before writing into
CHANGELOG.mdon main branch.
Monorepo Guidance
- Prefer commit scopes aligned to package names.
- Filter commit stream by scope for package-specific releases.
- Keep infra-wide changes in root changelog.
- Store package changelogs near package roots for ownership clarity.
Failure Handling
- If no valid conventional commits found: fail early, do not generate misleading empty notes.
- If git range invalid: surface explicit range in error output.
- If write target missing: create safe changelog header scaffolding.
04 同仓库更多 Skills
zustand-store-ts
Create Zustand stores with TypeScript, subscribeWithSelector middleware, and proper state/action separation. Use when building React state management, creating global stores, or implementing reacti...
zoom-automation
Automate Zoom meeting creation, management, recordings, webinars, and participant tracking via Rube MCP (Composio). Always search tools first for current schemas.
zoho-crm-automation
Automate Zoho CRM tasks via Rube MCP (Composio): create/update records, search contacts, manage leads, and convert leads. Always search tools first for current schemas.
zod-validation-expert
Expert in Zod — TypeScript-first schema validation. Covers parsing, custom errors, refinements, type inference, and integration with React Hook Form, Next.js, and tRPC.
zeroize-audit
Detects missing zeroization of sensitive data in source code and identifies zeroization removed by compiler optimizations, with assembly-level analysis, and control-flow verification. Use for auditing C/C++/Rust code handling secrets, keys, passwords, or other sensitive data.
zendesk-automation
Automate Zendesk tasks via Rube MCP (Composio): tickets, users, organizations, replies. Always search tools first for current schemas.