Linux command
git-changelog 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Generate changelog
git changelog
Changelog since tag
git changelog --tag [v1.0.0]
List commits only
git changelog --list
Changelog to file
git changelog > CHANGELOG.md
Specify commit range
git changelog [v1.0.0]..[v2.0.0]
说明
git changelog generates a changelog from git commit history. It formats commits into release notes, grouped by version tags or date ranges, suitable for documentation. The command is part of git-extras and supports various output formats. It can filter merge commits, format messages, and generate markdown-ready output suitable for inclusion in project documentation. Using tags as version markers, it groups commits into release sections, making it straightforward to maintain a CHANGELOG.md file that documents the evolution of a project.
参数
- --tag _TAG_
- Generate since tag.
- --list
- List commits without formatting.
- --no-merges
- Exclude merge commits.
- --all
- Include all commits.
- --help
- Display help information.
FAQ
What is the git-changelog command used for?
git changelog generates a changelog from git commit history. It formats commits into release notes, grouped by version tags or date ranges, suitable for documentation. The command is part of git-extras and supports various output formats. It can filter merge commits, format messages, and generate markdown-ready output suitable for inclusion in project documentation. Using tags as version markers, it groups commits into release sections, making it straightforward to maintain a CHANGELOG.md file that documents the evolution of a project.
How do I run a basic git-changelog example?
Run `git changelog` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --tag _TAG_ do in git-changelog?
Generate since tag.