LinuxCommandLibrary

git-changelog

TLDR

Generate changelog

$ git changelog
copy
Changelog since tag
$ git changelog --tag [v1.0.0]
copy
List commits only
$ git changelog --list
copy
Changelog to file
$ git changelog > CHANGELOG.md
copy
Specify commit range
$ git changelog [v1.0.0]..[v2.0.0]
copy

SYNOPSIS

git changelog [options] [range]

DESCRIPTION

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 merges, format messages, and generate markdown-ready output.
git changelog automates release documentation from commit history.

PARAMETERS

RANGE

Commit range for changelog.
--tag TAG
Generate since tag.
--list
List commits without formatting.
--no-merges
Exclude merge commits.
--all
Include all commits.
--help
Display help information.

CAVEATS

Part of git-extras package. Quality depends on commit messages. May need customization for project conventions.

HISTORY

git changelog is part of git-extras, created by TJ Holowaychuk to automate changelog generation from repository history.

SEE ALSO

git-log(1), git-tag(1)

Copied to clipboard