Template Placeholders

Placeholders are framed by curly braces {placeholder}} as in Mustache templates. The program then inserts the relevant data for your changelog in place of the placeholders.

📚 Read more about Templates in Changelog-Publisher.

Basic values

• The app name {{appName}}
• The changelog title {{changelogTitle}}
• The changelog subtitle {{changelogSubtitle}}

Releases

• Unreleased between {{#unreleased?}} and {{/unreleased?}}
• Releases between {{#releases?}} and {{/releases?}}

Placeholder for releases:

• The release description {{content}}

Version placeholder

The version name is composed of several elements. (Not available for unreleased)

{{version_major}}.{{version_minor}}{{#version_showPatch}}.{{version_patch}}{{/version_showPatch}} {{#version_betaVersion}}beta {{version_beta}}{{/version_betaVersion}}

• MAJOR version {{version_major}}
• MINOR version {{version_minor}}
• Patch version {{version_patch}}
• Beta version {{version_beta}}
• Patch area if patch > 0 {{#version_showPatch}} and {{/version_showPatch}}
• Beta area if beta > 0 {{#version_betaVersion}} and {{/version_betaVersion}}

Changes

Changes can be ungrouped between {#changes}}and {/changes}}, or grouped between {#changesgrouped}}and {/changesgrouped}}.

Placeholder for changes:

• The change type {{type}}
• The change description {{content}}

{{#changes}}
 - {{type}} {{content}}
{{/changes}}

Grouped changes

• Releases between {{#changesgrouped?}} and {{/changesgrouped?}}

A group is enclosed by two placeholders. Between them can be text and placeholders for the list of changes.

{{#feature-group}}
### ✨ Feature
{{#feature}}
 - {{content}}
{{/feature}}
{{/feature-group}}

Groups

• Breaking: {{#breaking-group}} and {{/breaking-group}} List: {{#breaking}} {{/breaking}}

• Feature: {{#feature-group}} and {{/feature-group}} List: {{#feature}} {{/feature}}

• Changed: {{#improvement-group}} and {{/improvement-group}} List: {{#improvement}} {{/improvement}}

• Fixed: {{#fixed-group}} and {{/fixed-group}} List: {{#fixed}} {{/fixed}}

• Removed: {{#removed-group}} and {{/removed-group}} List: {{#removed}} {{/removed}}

• Deprecated: {{#deprecated-group}} and {{/deprecated-group}} List: {{#deprecated}} {{/deprecated}}

• Security: {{#security-group}} and {{/security-group}} List: {{#security}} {{/security}}

• Chore: {{#chore-group}} and {{/chore-group}} List: {{#chore}} {{/chore}}

• Performance: {{#perf-group}} and {{/perf-group}} List: {{#perf}} {{/perf}}

• Docs: {{#docs-group}} and {{#docs-group}} and {{/docs-group}} List: {{#docs}} {{/docs}}

• The change description {{content}}

Samples

Markdown 1

# {{appName}}

## {{changelogTitle}}

### {{changelogSubtitle}}

{{#unreleased?}}
# Unreleased
 - {{content}}
{{#changes}}
 - {{type}} {{content}}
{{/changes}}
{{/unreleased?}}

{{#releases}}
## {{version_major}}.{{version_minor}}{{#version_showPatch}}.{{version_patch}}{{/version_showPatch}} {{#version_betaVersion}}beta {{version_beta}}{{/version_betaVersion}}

{{content}}

{{#changes}}
 - {{type}} {{content}}
{{/changes}}

{{/releases}}

Markdown 2

# {{appName}}

## {{changelogTitle}}

### {{changelogSubtitle}}

{{#unreleased?}}
# Unreleased
 - {{content}}

{{#changesgrouped}}
{{#feature-group}}
### ✨ Feature
{{#feature}}
 - {{content}}
{{/feature}}
{{/feature-group}}

{{#improvement-group}}
### 💎 Improved
{{#improvement}}
 - {{content}}
{{/improvement}}
{{/improvement-group}}

{{#fixed-group}}
### 🐞 Fixed
{{#fixed}}
 - {{content}}
{{/fixed}}
{{/fixed-group}}

{{#removed-group}}
### ❌ Removed
{{#removed}}
 - {{content}}
{{/removed}}
{{/removed-group}}

{{#deprecated-group}}
### 🚫 Deprecated
{{#deprecated}}
 - {{content}}
{{/deprecated}}
{{/deprecated-group}}

{{#security-group}}
### 🛡️ Security
{{#security}}
 - {{content}}
{{/security}}
{{/security-group}}

{{#breaking-group}}  
### 🚨  Breaking
{{#breaking}}
  ▫️ {{content}}
	 {{category}}  {{#tags}} {{tag}}  {{/tags}} 
{{/breaking}}
{{/breaking-group}}

{{#perf-group}}  
### ⚡️ Performance
{{#perf}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}} 
 {{/perf}}
{{/perf-group}}

{{#docs-group}}
### 📚  Docs
{{#docs}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}}  
 {{/docs}}
{{/docs-group}}

{{#chore-group}}  
### 🏗  Chore
{{#chore}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}}  
 {{/chore}}
{{/chore-group}}

{{/changesgrouped}}

{{/unreleased?}}


{{#releases}}
## {{version_major}}.{{version_minor}}{{#version_showPatch}}.{{version_patch}}{{/version_showPatch}} {{#version_betaVersion}}beta {{version_beta}}{{/version_betaVersion}}

{{content}}

{{#changesgrouped}}
{{#feature-group}}
### ✨ Feature
{{#feature}}
 - {{content}}
{{/feature}}
{{/feature-group}}

{{#improvement-group}}
### 💎 Improved
{{#improvement}}
 - {{content}}
{{/improvement}}
{{/improvement-group}}
    
{{#fixed-group}}
### 🐞 Fixed
{{#fixed}}
 - {{content}}
{{/fixed}}
{{/fixed-group}}
    
{{#removed-group}}
### ❌ Removed
{{#removed}}
 - {{content}}
{{/removed}}
{{/removed-group}}
    
{{#deprecated-group}}
### 🚫 Deprecated
{{#deprecated}}
 - {{content}}
{{/deprecated}}
{{/deprecated-group}}


{{#security-group}}
### 🛡️ Security
{{#security}}
 - {{content}}
{{/security}}
{{/security-group}}

{{#breaking-group}}  
### 🚨  Breaking
{{#breaking}}
  ▫️ {{content}}
	 {{category}}  {{#tags}} {{tag}}  {{/tags}} 
{{/breaking}}
{{/breaking-group}}

{{#perf-group}}  
### ⚡️ Performance
{{#perf}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}} 
 {{/perf}}
{{/perf-group}}

{{#docs-group}}
### 📚  Docs
{{#docs}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}}  
 {{/docs}}
{{/docs-group}}

{{#chore-group}}  
### 🏗  Chore
{{#chore}}
  ▫️ {{content}}   
	 {{category}}  {{#tags}} {{tag}}  {{/tags}}  
 {{/chore}}
{{/chore-group}}

{{/changesgrouped}}

{{/releases}}