changelog init cli command
docs-builder changelog init [options]
Initialize changelog configuration and folder structure for a repository.
The command locates the docs folder using the following priority:
- A
docsfolder containingdocset.ymlin the repository root ordocs/directory. - A
docsfolder withoutdocset.yml. - If no docs folder exists, creates
{path}/docs.
The command creates a changelog.yml configuration file and changelog and releases subdirectories in the docs folder. The generated changelog.yml contains the minimal configuration for the automated release notes path: type mappings for feature, bug-fix, and breaking-change, and a skip-label rule.
When changelog.yml already exists, the command updates only the directory paths if --changelog-dir or --bundles-dir are specified, and leaves all other content unchanged.
--pathstring-
Repository root. Defaults to cwd.
Constraints: symbolic links not allowed
--changelog-dirstring-
Changelog entry directory. Defaults to docs/changelog.
Constraints: symbolic links not allowed
--bundles-dirstring-
Bundle output directory. Defaults to docs/releases.
Constraints: symbolic links not allowed
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--skip-private-repositories- Skip cloning private repositories
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--skip-private-repositories- Skip cloning private repositories
# Standard initialization
docs-builder changelog init
# From a subdirectory, specifying the repo root
docs-builder changelog init --path /path/to/my-repo
# Custom changelog and bundles directories
docs-builder changelog init \
--changelog-dir ./my-changelogs \
--bundles-dir ./my-releases