releaseherald needs at least a known git repository to run. It can be provided as a command line
parameter --git-dir path/to/git/dir
or just simply running releaseherlad somewhere in a git repository. The root of the git repository is considered as
the place of the config files. If no config files exists it will run with defaults, which will be detailed below.
releaseherald can read its config from either releaseherald.toml, or if that does not exist it check for a
pyproject.toml where it looks for the [tool.releaseherald] section. Of course the path to the config can be passed
from the command line as --config path/to/config.file
base plugin configuration
: The pattern is used to select the versions from the repository, it can have a group named version which, if present,
will be used as the version number, if no souch group then the whole label will be used.
Default: "(?P<version>(\d*)\.(\d*)\.(\d*))"
: The path to the news fragment directory, if relative, it is relative to the repository root.
Default: news_fragment
: If true a version named Unreleassed will be generated with the news fragments added since the last release toll the
current state of the repo.
Default: false
: Last tag considered in the history. Only generate news for versions that happened after that version. It must
match version_tag_pattern.
Default ""
base_output plugin configuration
: Path of the base news file. This is the file that will be extended with the news for versions that releaseherald
generate. It must have an insert_marker which is the point where the news will be inserted. The
other parts of the file is not tuched, so it can have a proper header, or even some old frozen version news.
Default: news.rst
: Regexp in the news file where the news need to be inserted. The generated news will be inserted under the matched line
leaving the line in the file.
Default: "^(\s)*\.\. releaseherald_insert(\s)*$"
: Path to the version template file. This is file should use Jinja syntax, and render the news for a single version. See the details in Version template
: Path to the target of the generated news file. If not provided the generated news will be dumped to stdout.
Default: None
: If false it only generates the version news but do not insert it into the news file template. Using false together
with latest one can generate a simple representation of the latest version, which is great for an
announcement mail/post.
Default: true
latest plugin configuration
: If true only render the latest version. Can be used if one always update the news file and commit that into git
repository.
Default: false
filename_metadata_extractor plugin configuration
: This setting configure the extraction of metadata from news file names. The extracted information made available through the [News][releaseherald.plugins.interface.News] metadata to the template. ::: releaseherald.plugins.metadata_extractor.FilenameMetadataExtractorConfig rendering: show_source: false show_bases: false show_root_toc_entry: false members_order: source docstring_section_style: list
submodules plugin configuration
::: releaseherald.plugins.submodules.SubmoduleConfig rendering: show_source: false show_bases: false show_root_toc_entry: false members_order: source docstring_section_style: list
: The list of plugins enabled for this config. The base and base_ouput plugin that provide the basic behvior of
releaseherald is always included unless -base and/or -base-output is added to the list. If not set then some of
the stock plugins are autoloaded.
Default: [base, base_output, filename_metadata_extractor, latest, submodules]