Command line interface¶
This documentation is dynamically generated from the built-in --help
documentation provided by the proclamation command.
proclamation¶
Proclamation builds your changelog 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 updated changelog file.
proclamation build [OPTIONS] VERSION
Options
- --date <release_date>¶
Release date if not today.
- -k, --keep-fragments¶
Keep processed fragments
- -d, --dry-run¶
Write an updated changelog to stdout instead of disk. Implies –keep-fragments
Arguments
- VERSION¶
Required argument
draft¶
Preview the new VERSION portion of your changelog 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
merge¶
Merge changelog fragment files into a single file with bullet points.
proclamation merge [OPTIONS] FILENAME...
Arguments
- FILENAME...¶
Optional argument(s)
remove-fragments¶
Remove changelog fragment files associated with all/specified projects.
Typically you can allow “build” to do this for you instead of doing this manually.
proclamation remove-fragments [OPTIONS]
Options
- --yes¶
Confirm the action without prompting.