cli

Command line interface for generate_changelog.

FUNCTION	DESCRIPTION
`cli`	Generate a change log from git commits.
`echo`	Display a message to the user.
`generate_config_callback`	Generate a default configuration file.
`get_user_config`	Get the default configuration and update it with the user’s config file.

Attributes¶

Classes¶

Functions¶

cli ¶

cli(
    config: Optional[Path],
    repo_path: Optional[Path],
    starting_tag: Optional[str],
    output: Optional[str],
    skip_output_pipeline: bool,
    branch_override: Optional[str],
    debug_report: Optional[Path],
    verbose: int,
) -> None

Generate a change log from git commits.

echo ¶

echo(message: str, quiet: bool = False) -> None

Display a message to the user.

PARAMETER	DESCRIPTION
`message`	The message to send to the user TYPE: `str`
`quiet`	Do it quietly TYPE: `bool` DEFAULT: `False`

generate_config_callback ¶

generate_config_callback(ctx: Context, param: Parameter, value: bool) -> None

Generate a default configuration file.

get_user_config ¶

get_user_config(
    config_file: Optional[Path], echo_func: Callable
) -> Configuration

Get the default configuration and update it with the user’s config file.

PARAMETER	DESCRIPTION
`config_file`	The path to the user’s configuration file TYPE: `Optional[Path]`
`echo_func`	The function to call to echo output TYPE: `Callable`

RETURNS	DESCRIPTION
`Configuration`	The configuration object