github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(changelog) improve changelog template

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2021-11-10 12:14:20 +01:00
parent 9113b9d4fb
commit bf76d235e0
1 changed files with 88 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
scripts/changelog-template.hbs
View File

@@ -1,28 +1,106 @@
{{#each releases}} {{#each releases}}
## [{{title}}]({{href}}) {{niceDate}} ## [{{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}}) - :warning: {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#commit-list fixes heading='' message='BREAKING CHANGE'}}
{{#commit-list commits heading='### New Features' message='^feat' exclude='BREAKING CHANGE:'}} - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
- {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#commit-list commits heading='### Performance' message='^perf' 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}}) - {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#commit-list fixes heading='' message='^arch' exclude='BREAKING CHANGE'}}
{{#commit-list commits heading='### Fixes' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE:)'}} - {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
- {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#commit-list commits heading='### Docs' message='^docs'}} ### 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}}) - {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#commit-list fixes heading='' message='^feat' exclude='BREAKING CHANGE'}}
- {{commit.subject}} [`{{commit.shorthash}}`]({{commit.href}})
{{/commit-list}}
{{#commit-list commits heading='### Others' exclude='(^fix|^feat|^perf|^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}}) - {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}} {{/commit-list}}
{{#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}} {{/each}}