Skip to content

Instantly share code, notes, and snippets.

@vineyardbovines

vineyardbovines/changelog-template.hbs

Last active January 16, 2024 22:09
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save vineyardbovines/11c479f249a20b1e53efd82c81c05142 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save vineyardbovines/11c479f249a20b1e53efd82c81c05142 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. vineyardbovines revised this gist Jan 16, 2024. 1 changed file with 29 additions and 8 deletions.
    37 changes: 29 additions & 8 deletions changelog-template.hbs
    View file
    Original file line number Diff line number Diff line change
    @@ -1,16 +1,37 @@
    # Changelog

    The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
    and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

    {{#each releases}}
    {{#if @first}}
    {{#if href}}
    ## [{{title}}]({{href}}){{#if tag}} - {{isoDate}}{{/if}}
    {{else}}
    ## {{title}}{{#if tag}} - {{isoDate}}{{/if}}
    {{/if}}

    {{#if summary}}
    {{summary}}
    {{/if}}

    {{#if merges}}
    ### Merged

    {{#each merges}}
    ## Unreleased
    - {{{message}}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}
    {{/each}}
    {{/if}}

    {{#if fixes}}
    ### Fixed

    {{#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}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{commit.subject}}{{#each fixes}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}{{/each}}
    {{/each}}
    {{/if}}
    {{/each}}

    {{#commit-list commits heading='### Commits'}}
    - {{#if breaking}}**Breaking change:** {{/if}}{{subject}} {{#if href}}[`{{shorthash}}`]({{href}}){{/if}}
    {{/commit-list}}

    {{/each}}
  2. vineyardbovines revised this gist Jan 16, 2024. 1 changed file with 8 additions and 27 deletions.
    35 changes: 8 additions & 27 deletions changelog-template.hbs
    View file
    Original file line number Diff line number Diff line change
    @@ -3,33 +3,14 @@
    {{#each releases}}
    {{#if @first}}
    {{#each merges}}
    ## Unreleased
    - {{{message}}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    ## Unreleased
    - {{{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}}

    {{#if href}}
    ###{{#unless major}}#{{/unless}} [{{title}}]({{href}})
    {{else}}
    #### {{title}}
    {{/if}}

    {{#if tag}}
    > {{niceDate}}
    {{/if}}

    {{#if summary}}
    {{summary}}
    {{/if}}

    {{#each merges}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    {{/each}}
    {{#each fixes}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{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}}

    {{/each}}
  3. vineyardbovines revised this gist Jan 16, 2024. 1 changed file with 0 additions and 15 deletions.
    15 changes: 0 additions & 15 deletions changelog-template.hbs
    View file
    Original file line number Diff line number Diff line change
    @@ -1,20 +1,5 @@
    # Changelog

    {{#each releases}}
    {{#if @first}}
    {{#each merges}}
    ## Unreleased
    - {{{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}}

    {{#each releases}}
    {{#if @first}}
    {{#each merges}}
  4. vineyardbovines revised this gist Jan 16, 2024. 1 changed file with 35 additions and 0 deletions.
    35 changes: 35 additions & 0 deletions changelog-template.hbs
    View file
    Original file line number Diff line number Diff line change
    @@ -3,6 +3,7 @@
    {{#each releases}}
    {{#if @first}}
    {{#each merges}}
    ## Unreleased
    - {{{message}}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    {{/each}}
    {{#each fixes}}
    @@ -12,4 +13,38 @@
    - {{#if breaking}}**Breaking change:** {{/if}}{{{subject}}}{{#if href}} [`{{shorthash}}`]({{href}}){{/if}}
    {{/each}}
    {{/if}}
    {{/each}}

    {{#each releases}}
    {{#if @first}}
    {{#each merges}}
    ## Unreleased
    - {{{message}}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    {{/each}}
    {{/if}}

    {{#if href}}
    ###{{#unless major}}#{{/unless}} [{{title}}]({{href}})
    {{else}}
    #### {{title}}
    {{/if}}

    {{#if tag}}
    > {{niceDate}}
    {{/if}}

    {{#if summary}}
    {{summary}}
    {{/if}}

    {{#each merges}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
    {{/each}}
    {{#each fixes}}
    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{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}}

    {{/each}}
  5. vineyardbovines created this gist Jan 16, 2024.
    15 changes: 15 additions & 0 deletions changelog-template.hbs
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,15 @@
    # Changelog

    {{#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}}