changelog render cli command
docs-builder changelog render [options]
Render one or more changelog bundles to Markdown or AsciiDoc.
--inputstring[]-
Required: Bundle input(s) in format "bundle-file-path|changelog-file-path|repo|link-visibility" (use pipe as delimiter). To merge multiple bundles, separate them with commas. Only bundle-file-path is required. link-visibility can be "hide-links" or "keep-links" (default). Use "hide-links" for private repositories; when set, all PR and issue links for each affected entry are hidden (entries may have multiple links via the prs and issues arrays). Paths support tilde (~) expansion and relative paths.
Repeatable: pass
--inputmultiple times to supply more than one value --configstring-
Optional: Path to the changelog.yml configuration file. Defaults to 'docs/changelog.yml'
Constraints: symbolic links not allowed, must exist, extensions: yml, yaml, supports
~home expansion --file-typestring-
Optional: Output file type. Valid
Values: "markdown" or "asciidoc". Defaults to "markdown"
Default:
markdown --hide-featuresstring[]-
Filter by feature IDs (comma-separated), or a path to a newline-delimited file containing feature IDs. Can be specified multiple times. Entries with matching feature-id values will be commented out in the output.
Repeatable: pass
--hide-featuresmultiple times to supply more than one value --outputstring- Optional: Output directory for rendered files. Defaults to current directory
--[no-]subsections-
Optional: Group entries by area/component in subsections. For breaking changes with a subtype, groups by subtype instead of area. Defaults to false
Default:
false --titlestring- Optional: Title to use for section headers in output files. Defaults to version from first bundle
-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
--[no-]skip-private-repositories-
Skip cloning private repositories