raver 3.0.2

Check w.r.t. git reference

To check the current version versus a git branch as reference (e.g. origin/master), use:

raver --ref origin/master

where origin/master is the reference branch. It then performs a comparison using git diff to check for committed changes. -r works as well as a shorthand.

Check changelog

To check whether a changelog entry exists for the current version. There are two supported changelog methods, file and directory.

raver --changelog ./path/to/changelog.rst

where the changelog file can be of any extension. Raver checks whether the earlier detected Python file version (only {major}.{minor}.{patch}, no metadata) is included in the document.

raver --changelog ./path/to/changelog/

is also allowed, where the changelog directory has to contain an entry in the format of v{major}.{minor}.{patch}* of the current version (the star is a glob wildcard).

TOML configuration

Raver supports TOML configuration! It takes precedence over any command-line parameters. The following would be a sensible default for raver:

[tool.raver]
module = "raver"  # Change to your package name or remove to use Poetry's entry.
reference = "origin/main"
changelog = "./doc/source/changelog.rst"
debug = false