Command line interface

This documentation is dynamically generated from the built-in --help documentation provided by the proclamation command.

proclamation

Proclamation builds your NEWS files from fragments.

proclamation [OPTIONS] COMMAND [ARGS]...

Options

-c, --config <config_file>

Config filename

Default:

.proclamation.json

-p, --project <NAME>

Specify a single project from the config to process. If omitted, all projects in the config will be processed.

--default-base <default_base>

Specify a different default base directory to search.

-v, --verbose

Show verbose info messages. Repeat for more verbosity.

build

Build your new NEWS file.

proclamation build [OPTIONS] VERSION

Options

--date <release_date>

Release date if not today.

-d, --delete-fragments

Delete processed fragments when complete

-o, --overwrite

Write updated changelog to disk, instead of to stdout.

Arguments

VERSION

Required argument

draft

Preview the new VERSION portion of your NEWS file(s) to stdout.

If no version is provided, a placeholder value is used.

proclamation draft [OPTIONS] VERSION

Options

--date <release_date>

Release date if not today.

Arguments

VERSION

Optional argument

remove-fragments

Remove NEWS fragments associated with all/specified projects.

If you only have one project, or your projects don’t share sections, you may consider using the –delete-fragments option of “build” instead.

proclamation remove-fragments [OPTIONS]

Options

--yes

Confirm the action without prompting.