Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 1.2 KB

README.md

File metadata and controls

59 lines (35 loc) · 1.2 KB

git-changelog

Generate a changelog text from git history

Usage

git-changelog [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]
    [--previous-commit PREVIOUS_COMMIT]
    [--skip-pattern SKIP_PATTERN]
    [--commit-limit COMMIT_LIMIT]
    ACTION

Optional arguments for command git-changelog

--previous-commit=PREVIOUS_COMMIT

Commit ID starting from which to generate the log

--skip-pattern=SKIP_PATTERN

Regex pattern to skip unneeded commit message lines. Default: ^[Mm]erged? (remote-tracking )?(branch|pull request|in) .*

--commit-limit=COMMIT_LIMIT

Maxmimum number of commits to retrieve from git before filtering. Default: 50

Common options

-h, --help

show this help message and exit

--log-stream=stderr | stdout

Log output stream. Default stderr

--no-color

Do not use ANSI colors to format terminal output

--version

Show tool version and exit

-s, --silent

Disable log output for commands

-v, --verbose

Enable verbose logging for commands

Actions

Action Description
generate Generate a changelog text from git history