Commit changelog version¶

Standard-version¶

Can be invoked via git rel alias to do a release.

Copy the files .versionrc.json and antora-version-updater.js into the repository.

$ cp /.config/standard-version/.versionrc.json .
$ cp /.config/standard-version/antora-version-updater.js docs/

file:///home/rolf/.config/standard-version/.versionrc.json

include::example$standard-version.json[]

The Antora version updater does a simple text replacement. Ideally, it would use a YAML parser, but that's more work to implement cross-repository.

file:///home/rolf/.config/standard-version/antora-version-updater.js

include::example$antora-version-updater.js[]

:::: note ::: title Note :::

The file .versionrc.json is also symlinked into the home directory.

Since standard-version searches up through directories, it will eventually find this file and use it as \"global config\".

However, it seems to make sense to include it in the repository. This will ensure consistent updates by all users. ::::

:::: caution ::: title Caution :::

For the Antora version update, the configuration in in .versionrc.json expects a single set of documentation, using docs/antora.yml.

It is possible to expand this to include more sets of documentation, by adapting .versionrc.json. ::::