From b09910b39824c264e8e18afc778f1baeff3c7468 Mon Sep 17 00:00:00 2001 From: Mo Gorhom Date: Tue, 22 Dec 2020 16:47:45 +0100 Subject: [PATCH] chore: updated auto-changelog configs --- .auto-changelog | 7 +++++++ .release-it.json | 6 +++--- templates/changelog-template.hbs | 30 ++++++++++++++++++++++++++++++ templates/release-template.hbs | 19 +++++++++++++++++++ 4 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 .auto-changelog create mode 100644 templates/changelog-template.hbs create mode 100644 templates/release-template.hbs diff --git a/.auto-changelog b/.auto-changelog new file mode 100644 index 00000000..3f48517e --- /dev/null +++ b/.auto-changelog @@ -0,0 +1,7 @@ +{ + "handlebarsSetup": "./scripts/auto-changelog.js", + "ignoreCommitPattern": "^chore: release v", + "tagPattern": "^v(0|1|2)+\\.\\d+\\.\\d+$", + "unreleased": false, + "commitLimit": false +} \ No newline at end of file diff --git a/.release-it.json b/.release-it.json index bc702809..91f8db35 100644 --- a/.release-it.json +++ b/.release-it.json @@ -3,11 +3,11 @@ "push": true, "tagName": "v${version}", "commitMessage": "chore: release v${version}", - "changelog": "auto-changelog --stdout --commit-limit false --ignore-commit-pattern \"^chore: release v\" --unreleased --template ./release-template.hbs --tag-pattern \"^v\\d+\\.\\d+\\.\\d+$\" --handlebars-setup ./scripts/auto-changelog.js" + "changelog": "auto-changelog --stdout --unreleased --template ./templates/changelog-template.hbs" }, "github": { "release": true, - "releaseNotes": "auto-changelog --stdout --commit-limit false --ignore-commit-pattern \"^chore: release v\" --unreleased --template ./release-template.hbs --tag-pattern \"^v\\d+\\.\\d+\\.\\d+$\" --handlebars-setup ./scripts/auto-changelog.js" + "releaseNotes": "auto-changelog --stdout --template ./templates/release-template.hbs" }, "npm": { "publish": false @@ -18,6 +18,6 @@ } }, "hooks": { - "after:bump": "auto-changelog -p --ignore-commit-pattern \"^chore: release v\" --template ./release-template.hbs --tag-pattern \"^v\\d+\\.\\d+\\.\\d+$\" --handlebars-setup ./scripts/auto-changelog.js" + "after:bump": "auto-changelog -p --template ./templates/changelog-template.hbs" } } diff --git a/templates/changelog-template.hbs b/templates/changelog-template.hbs new file mode 100644 index 00000000..3daecc02 --- /dev/null +++ b/templates/changelog-template.hbs @@ -0,0 +1,30 @@ +# Changelog + +{{#each releases}} + {{#if href}} + ## [{{title}}]({{href}}){{#if tag}} - {{isoDate}}{{/if}} + {{else}} + ## {{title}}{{#if tag}} - {{isoDate}}{{/if}} + {{/if}} + + {{#if summary}} + {{summary}} + {{/if}} + + {{#custom merges commits heading="#### Features" subject="feat: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Improvements" subject="(chore|refactor|style): "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Fixes" subject="fix: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Documentations" subject="docs: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + +{{/each}} \ No newline at end of file diff --git a/templates/release-template.hbs b/templates/release-template.hbs new file mode 100644 index 00000000..f2a66561 --- /dev/null +++ b/templates/release-template.hbs @@ -0,0 +1,19 @@ +{{#each releases}} + {{#if @first}} + {{#custom merges commits heading="#### Features" subject="feat: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Improvements" subject="(chore|refactor|style): "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Fixes" subject="fix: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + + {{#custom merges commits heading="#### Documentations" subject="docs: "}} + - {{message}} ({{#if id}}[`#{{id}}`]{{else}}[{{shorthash}}]{{/if}}({{href}})). + {{/custom}} + {{/if}} +{{/each}} \ No newline at end of file