Add auto-changelog template file to be used directly from the reposit…

…ory (#583)
release-it · Jan 11, 2020 · fd67e6c · fd67e6c
1 parent 47548b5
commit fd67e6c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/recipes/auto-changelog.md b/docs/recipes/auto-changelog.md
@@ -45,3 +45,17 @@ unreleased tag:
   {{/if}}
 {{/each}}
 ```
+
+You can also use the template above [changelog-compact-template.hbs](./changelog-compact-template.hbs)
+directly from the URL:
+
+```json
+{
+  "hooks": {
+    "before:release": "npx auto-changelog -p"
+  },
+  "git": {
+    "changelog": "npx auto-changelog --stdout --commit-limit false --unreleased --template https://raw.githubusercontent.com/release-it/release-it/master/docs/recipes/changelog-compact-template.hbs"
+  }
+}
+```
diff --git a/docs/recipes/changelog-compact-template.hbs b/docs/recipes/changelog-compact-template.hbs
@@ -0,0 +1,13 @@
+{{#each releases}}
+  {{#if @first}}
+    {{#each merges}}
+      - {{{message}}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
+    {{/each}}
+    {{#each fixes}}
+      - {{{commit.subject}}}{{#each fixes}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}{{/each}}
+    {{/each}}
+    {{#each commits}}
+      - {{#if breaking}}**Breaking change:** {{/if}}{{{subject}}}{{#if href}} [`{{shorthash}}`]({{href}}){{/if}}
+    {{/each}}
+  {{/if}}
+{{/each}}