Table of Contents

Changelog - Templating

Git2SemVer generates the changelog using Scriban scripting language template file .git2semver/changelog/markdown.template.scriban. If no template is provided Git2SemVer will install and its default template file.

Essentials

The template must generate a markdown file with section markers. Section markers are HTML comments that identify sections Git2SemVer can update. The section format is:

<!-- Section start: section_name -->
    :
<!-- Section start: section_name -->

See section markers in the default template file markdown.template.scriban.

Customising

The template file can be edited. A new changelog (or after the existing changelog is deleted) will use the edited template. Any changes to the template's next release section will be seen when a new release is added to the changelog. Any changes to the template's version section will impact the next release sections title/version on next changelog generation.

Model

Values are passed to the Scriban template in a model. See class ChangelogScribanModel.

Edit this page