git-changelog

git changelog [options] [file]

git changelog generates a changelog from git tags (annotated or lightweight) and commit messages. It formats commits into release notes, grouped into sections by tag, suitable for a project's CHANGELOG.If no tags exist, every commit is included; otherwise only commits since the most recent tag are shown by default (use --start-tag/--final-tag to target a specific range). An existing Change*/History* file in the current directory is auto-detected and its content appended after the newly generated section, unless --prune-old is given.Commit formatting is controlled via the changelog.format (default ` * %s`) and changelog.mergeformat git config options.

FILE

Output filename; defaults to an auto-detected Change*/History* file, or History.md.

Include every commit, ignoring --start-tag/--start-commit/--final-tag.

Plain list of commits, without section titles/dates.

Label to use as the section title for the most-recent, untagged commits.

Oldest tag to start the commit range from.

Like --start-tag, but starts from a commit instead of a tag.

Newest tag to end the commit range at.

Exclude merge commits.

Include only merge commits, with subject and body.

Replace the existing changelog file instead of appending to it.

Write to standard output instead of a file.

Display help information.

Part of the git-extras package. Quality depends on commit messages. Tag-based grouping requires annotated or lightweight tags to already exist in the repository.

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

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

Source code · Documentation