generate-changelog

Generate a change log from git commits.

generate-changelog [OPTIONS]

Options

--version

Show program’s version number and exit

--generate-config

Generate a default configuration file

-c, --config <config_file>

Path to the config file.

-r, --repo-path <repository_path>

Path to the repository, if not within the current directory

-t, --starting-tag <starting_tag>

Tag to generate a changelog from.

-o, --output <output>

What output to generate.

Options:

release-hint | notes | all

--skip-output-pipeline

Do not execute the output pipeline in the configuration.

Default:

False

-b, --branch-override <branch_override>

Override the current branch for release hint decisions.

--install-completion <install_completion>

Install completion for the specified shell.

Options:

bash | zsh | fish | powershell | pwsh

--show-completion <show_completion>

Show completion for the specified shell, to copy it or customize the installation.

Options:

bash | zsh | fish | powershell | pwsh

Environment variables

CHANGELOG_CONFIG_FILE

Provide a default for --config