Command Reference
yaclog
Manipulate markdown changelog files.
yaclog [OPTIONS] COMMAND [ARGS]...
Options
- --path <FILE>
Location of the changelog file.
- Default
CHANGELOG.md
- --version
Show the version and exit.
Environment variables
- YACLOG_PATH
Provide a default for
--path
entry
Add entries to SECTION in VERSION
SECTION is the name of the section to append to. If not given, entries will be uncategorized.
VERSION is the name of the version to append to. If not given, the most recent version will be used, or a new ‘Unreleased’ version will be added if the most recent version has been released.
yaclog entry [OPTIONS] SECTION VERSION
Options
- -b, --bullet <TEXT>
Add a bullet point.
- -p, --paragraph <TEXT>
Add a paragraph
Arguments
- SECTION
Optional argument
- VERSION
Optional argument
format
Reformat the changelog file.
yaclog format [OPTIONS]
init
Create a new changelog file.
yaclog init [OPTIONS]
release
Release VERSION, or a version incremented from the last release.
VERSION is the name of the version to release. If VERSION is not provided but increment options are, then the most recent valid PEP440 version number is used instead.
The most recent version in the log will be renamed (except by the –commit option) by using the VERSION as well as any increment options. Increment options will always reset the later segments, and prerelease increments will clear other kinds of prerelease.
yaclog release [OPTIONS] VERSION
Options
- -M, --major
Increment major version number.
- -m, --minor
Increment minor version number.
- -p, --patch
Increment patch number.
- -a, --alpha
Increment alpha version number.
- -b, --beta
Increment beta version number.
- -r, --rc
Increment release candidate version number.
- -f, --full
Clear the prerelease value creating a full release.
- -c, --commit
Create a git commit tagged with the new version number. If there are no changes to commit, the current commit will be tagged instead.
- -C, -🦀, --cargo
Update the version in a Rust cargo.toml manifest file.
Arguments
- VERSION
Optional argument
show
Show the changes for VERSIONS.
VERSIONS is a list of versions to print. If not given, the most recent version is used.
yaclog show [OPTIONS] VERSIONS
Options
- -a, --all
Show the entire changelog.
- -m, --markdown, -t, --txt
Display as markdown or plain text.
- -f, --full
Show version header and body.
- -n, --name
Show only the version name
- -b, --body
Show only the version body.
- -h, --header
Show only the version header.
Arguments
- VERSIONS
Optional argument(s)
tag
Modify TAG on VERSION.
VERSION is the name of a version to add tags to. If not given, the most recent version is used.
yaclog tag [OPTIONS] TAG VERSION
Options
- -a, --add, -d, --delete
Add or delete tags
Arguments
- TAG
Required argument
- VERSION
Optional argument