Skip to content

Latest commit

 

History

History
118 lines (94 loc) · 3.69 KB

template.md

File metadata and controls

118 lines (94 loc) · 3.69 KB

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. The file is auto-generated using Conventional Commits.

Overview

{%- for release in releases %}

  • [{{ release.version }}](#{{ release.version }}) – {{ release.date | date(format="%Y.%m.%d")}} {%- endfor %}

[Unreleased]

{% if unreleased.changes -%} {%- for change in unreleased.changes -%} {% if change.merge_commit_description -%}

  • {{ change.type }}: {{ change.merge_commit_description.description }} ([#{{change.merge_commit_description.pr_number }}][pr#{{ change.merge_commit_description.pr_number }}]) ([{{ change.commit.short_id }}]) {%- else -%}
  • {{ change.type }}: {{ change.description }} ([{{ change.commit.short_id }}]) {%- endif %} {% endfor %} {% else -%} nothing new to show for… yet!

{% endif -%} {%- for release in releases -%}

[{{ release.version }}]{% if release.subject %} – {{ release.subject }}{% endif %}

{{ release.date | date(format="%Y.%m.%d") }} {%- if release.notes %}

{{ release.notes }} {% endif -%} {%- set ignored_contributors = get_env(name="IGNORE_CONTRIBUTORS", default="") | split(pat=",") -%} {%- set_global contributors = [] -%} {%- for contributor in release.changeset.contributors -%} {%- if ignored_contributors is not containing(contributor.email) -%} {%- set_global contributors = contributors | concat(with=contributor) -%} {%- endif -%} {%- endfor -%} {%- if contributors %}

Contributions

This release is made possible by the following people (in alphabetical order). Thank you all for your contributions. Your work – no matter how significant – is greatly appreciated by the community. 💖 {% for contributor in contributors %}

  • {{ contributor.name }} (<{{ contributor.email }}>) {%- endfor %} {% endif %}

Changes

{% for type, changes in release.changeset.changes | group_by(attribute="type") -%}

{{ type | typeheader }}

{% for change in changes -%}

  • {{ change.description }} ([{{ change.commit.short_id }}])

{% if change.body -%} {{ change.body | indent(n=2) }}

{% endif -%} {%- endfor -%}

{% endfor %} {%- endfor -%}

{% if config.github.repo -%} {%- set url = "https://github.com/" ~ config.github.repo -%} {%- else -%} {%- set url = "#" -%} {%- endif -%} {% if releases -%} [unreleased]: {{ url }}/compare/v{{ releases | first | get(key="version") }}...HEAD {%- else -%} [unreleased]: {{ url }}/commits {%- endif -%} {%- for release in releases %} [{{ release.version }}]: {{ url }}/releases/tag/v{{ release.version }} {%- endfor %}

{% for change in unreleased.changes %} [{{ change.commit.short_id }}]: {{ url }}/commit/{{ change.commit.id }} {%- endfor -%} {%- for release in releases %} {%- for change in release.changeset.changes %} [{{ change.commit.short_id }}]: {{ url }}/commit/{{ change.commit.id }} {%- endfor -%} {%- endfor %}

{% for change in unreleased.changes %} {%- if change.merge_commit_description -%} [pr#{{ change.merge_commit_description.pr_number }}]: {{ url }}/pull/{{ change.merge_commit_description.pr_number }} {% endif -%} {%- endfor -%} {%- for release in releases %} {%- for change in release.changeset.changes %} {%- if change.merge_commit_description -%} [pr#{{ change.merge_commit_description.pr_number }}]: {{ url }}/pull/{{ change.merge_commit_description.pr_number }} {% endif -%} {%- endfor -%} {%- endfor -%}