From bf76d235e010ac968e2edfba1661df6eec8cf0d1 Mon Sep 17 00:00:00 2001 From: Gabor Kiss-Vamosi Date: Wed, 10 Nov 2021 12:14:20 +0100 Subject: [PATCH] docs(changelog) improve changelog template --- scripts/changelog-template.hbs | 98 ++++++++++++++++++++++++++++++---- 1 file changed, 88 insertions(+), 10 deletions(-) diff --git a/scripts/changelog-template.hbs b/scripts/changelog-template.hbs index 7dbfad5e3..afba04d27 100644 --- a/scripts/changelog-template.hbs +++ b/scripts/changelog-template.hbs @@ -1,28 +1,106 @@ {{#each releases}} ## [{{title}}]({{href}}) {{niceDate}} - {{#commit-list commits heading='### Breaking Changes' message='BREAKING CHANGE:'}} + ### Breaking Changes + {{#commit-list merges heading='' message='BREAKING CHANGE'}} + - :warning: {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='BREAKING CHANGE'}} - :warning: {{subject}} [`{{shorthash}}`]({{href}}) {{/commit-list}} + {{#commit-list fixes heading='' message='BREAKING CHANGE'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} - {{#commit-list commits heading='### New Features' message='^feat' exclude='BREAKING CHANGE:'}} + ### Architectural + {{#commit-list merges heading='' message='^arch' exclude='BREAKING CHANGE'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^arch' exclude='BREAKING CHANGE'}} - {{subject}} [`{{shorthash}}`]({{href}}) {{/commit-list}} - - {{#commit-list commits heading='### Performance' message='^perf' exclude='BREAKING CHANGE:'}} + {{#commit-list fixes heading='' message='^arch' exclude='BREAKING CHANGE'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + ### New Features + {{#commit-list merges heading='' message='^feat' exclude='BREAKING CHANGE'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^feat' exclude='BREAKING CHANGE'}} - {{subject}} [`{{shorthash}}`]({{href}}) {{/commit-list}} - - {{#commit-list commits heading='### Fixes' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE:)'}} - - {{subject}} [`{{shorthash}}`]({{href}}) + {{#commit-list fixes heading='' message='^feat' exclude='BREAKING CHANGE'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) {{/commit-list}} - {{#commit-list commits heading='### Docs' message='^docs'}} + + ### Performance + {{#commit-list merges heading='' message='^perf' exclude='BREAKING CHANGE'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^perf' exclude='BREAKING CHANGE'}} - {{subject}} [`{{shorthash}}`]({{href}}) {{/commit-list}} - - {{#commit-list commits heading='### Others' exclude='(^fix|^feat|^perf|^docs)'}} + {{#commit-list fixes heading='' message='^perf' exclude='BREAKING CHANGE'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + ### Fixes + {{#commit-list merges heading='' message='^fix' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}} - {{subject}} [`{{shorthash}}`]({{href}}) {{/commit-list}} + {{#commit-list fixes heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + + ### Examples + {{#commit-list merges heading='' message='^example'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^example'}} + - {{subject}} [`{{shorthash}}`]({{href}}) + {{/commit-list}} + {{#commit-list fixes heading='' message='^example'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + + ### Docs + {{#commit-list merges heading='' message='^docs'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='^docs'}} + - {{subject}} [`{{shorthash}}`]({{href}}) + {{/commit-list}} + {{#commit-list fixes heading='' message='^docs'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + ### CI and tests + {{#commit-list merges heading='' message='(^ci|^test)'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' message='(^ci|^test)'}} + - {{subject}} [`{{shorthash}}`]({{href}}) + {{/commit-list}} + {{#commit-list fixes heading='' message='(^ci|^test)'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} + + ### Others + {{#commit-list merges heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}} + - {{message}} [`{{id}}`]({{href}}) + {{/commit-list}} + {{#commit-list commits heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}} + - {{subject}} [`{{shorthash}}`]({{href}}) + {{/commit-list}} + {{#commit-list fixes heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}} + - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}}) + {{/commit-list}} {{/each}}