changelog render

Generate markdown files from changelog bundle files.

To create the bundle files, use changelog bundle.

For details and examples, go to Create and bundle changelogs.

docs-builder changelog render [options...] [-h|--help]
		

--input <List<BundleInput>>

One or more bundle input files.

Each item can be specified as "bundle-file-path, changelog-file-path, repo" to accommodate files coming from multiple locations.

For example, --input "./changelog-bundle.yaml,./changelogs,elasticsearch".

Only bundle-file-path is required.

Use repo if your changelogs do not contain full URLs for the pull requests or issues; otherwise they will be incorrectly derived with "elastic/elastic" in the URL by default.

--output <string?>

Optional: The output directory for rendered markdown files.

Defaults to current directory.

--title <string?>

Optional: The title to use for section headers, directories, and anchors in output markdown files.

Defaults to the version in the first bundle.

If the string contains spaces, they are replaced with dashes when used in directory names and anchors.

--subsections

Optional: Group entries by area in subsections.

Defaults to false.

--hide-private-links

Optional: Hide private links by commenting them out in markdown output.

This option is useful when rendering changelog bundles in private repositories.

Defaults to false.