Skip to content

Commit

Permalink
tool: add changelog_gen.sh to automatically generate changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
kisvegabor committed Nov 4, 2021
1 parent d6341f0 commit 6d95521
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions scripts/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CHANGELOG_LAST.md
28 changes: 28 additions & 0 deletions scripts/changelog-template.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{{#each releases}}
## [{{title}}]({{href}}) {{niceDate}}

{{#commit-list commits heading='### Breaking Changes' message='BREAKING CHANGE:'}}
- :warning: {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}}

{{#commit-list commits heading='### New Features' message='^feat' exclude='BREAKING CHANGE:'}}
- {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}}

{{#commit-list commits heading='### Performance' message='^perf' 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}}

{{#commit-list commits heading='### Docs' message='^docs'}}
- {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}}

{{#commit-list commits heading='### Others' exclude='(^fix|^feat|^perf|^docs)'}}
- {{subject}} [`{{shorthash}}`]({{href}})
{{/commit-list}}

{{/each}}
15 changes: 15 additions & 0 deletions scripts/changelog_gen.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Generate CHANGELOG_LAST.md from changes since the last version tag. (vx.y.z-dev tags are ignored)
# CHANGELOG_LAST.md can be edited manually if required and manually added to docs/CHANGELOG.md
#
# Requirements:
# npm install -g auto-changelog
#
# Usage:
# changelog-gen <next-version>
#
# Example: if the latest verision is v5.6.7 the followings can be used for bugfix, minor or major versions:
# changelog-gen v5.6.8
# changelog-gen v5.7.0
# changelog-gen v6.0.0

auto-changelog -t changelog-template.hbs -l false --latest-version $1 --unreleased-only --tag-pattern ^v[0-9]+.[0-9]+.[0-9]+$ -o CHANGELOG_LAST.md

0 comments on commit 6d95521

Please sign in to comment.