Skip to content

buildChangeReportHtml

buildChangeReportHtml(changes, customTemplateSource?): string

Defined in: changeReportTemplate.ts:284

Render a Confluence-storage-format change report grouping a set of changed components by component type, for pasting into a release/change-management page.

ChangesByComponentType

The changed components, grouped by component type.

string

A user-supplied Handlebars template to render instead of the built-in one. Compiled against the same Handlebars instance as the built-in template, so it can also use the changeTable partial. See the README’s “Custom Templates” section for the changes data shape and the fields changeTable renders.

string

The rendered XHTML fragment.