Add emojis in release and changelog

[ibiscp]

Add emojis in release and changelog

[ibiscp]

@codejedi365 For anyone looking for the same thing.

.release_notes.md.j2

{% set emoji_map = {
    'breaking': '💥',
    'feature': '✨',
    'fix': '🐛',
    'performance': '⚡',
    'refactor': '♻️',
    'chore': '🚀',
    'documentation': '📖',
    'test': '✅',
    'ci': '🤖',
    'style': '🎨',
    'build': '🏗',
    'unknown': '❗',
} %}

{% macro commit_scope(commit_summary) %}{{ commit_summary.split(":")[0] }}{% endmacro %}
{% macro commit_content(commit_summary) %}{{ commit_summary.split(":")[1] }}{% endmacro %}
{% set order = emoji_map.keys() %}

## {{ version.as_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }})
{%- for type_ in order %}
{%- if type_ in release["elements"] %}
### {{ emoji_map[type_] }} {{ type_ | capitalize }}
{% for commit in release["elements"][type_] %}
{%- set scope = commit_scope(commit.commit.summary).split("(")[1] | replace(")", "") | default ("", true) %}
- {% if scope %}\[**{{ scope }}**\]{%endif%}{{ commit_content(commit.commit.summary) }} [\@{{ commit.commit.author.name }}](mailto:{{commit.commit.author.email}})
{%- endfor %}
{% endif %}
{% endfor %}

CHANGELOG.md.j2

{% set emoji_map = {
    'breaking': '💥',
    'feature': '✨',
    'fix': '🐛',
    'performance': '⚡',
    'refactor': '♻️',
    'chore': '🚀',
    'documentation': '📖',
    'test': '✅',
    'ci': '🤖',
    'style': '🎨',
    'build': '🏗',
    'unknown': '❗',
} %}

{% macro commit_scope(commit_summary) %}{{ commit_summary.split(":")[0] }}{% endmacro %}
{% macro commit_content(commit_summary) %}{{ commit_summary.split(":")[1] }}{% endmacro %}
{% set order = emoji_map.keys() %}

# CHANGELOG
{% if context.history.unreleased | length > 0 %}

{# UNRELEASED #}
## Unreleased
{%- for type_ in order %}
{%- if type_ in context.history.unreleased %}
### {{ emoji_map[type_] }} {{ type_ | capitalize }}
{% for commit in context.history.unreleased[type_] %}
{% set scope = commit_scope(commit.commit.summary).split("(")[1] | replace(")", "") | default ("", true) %}
- {% if scope %}\[**{{ scope }}**\]{%endif%}{{ commit_content(commit.commit.summary) }} [\@{{ commit.commit.author.name }}](mailto:{{commit.commit.author.email}})
{% endfor %}{% endif %}{% endfor %}{% endif %}

{# RELEASED #}
{% for version, release in context.history.released.items() %}
## {{ version.as_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }})
{%- for type_ in order %}
{%- if type_ in release["elements"] %}
### {{ emoji_map[type_] }} {{ type_ | capitalize }}
{% for commit in release["elements"][type_] %}
{% set scope = commit_scope(commit.commit.summary).split("(")[1] | replace(")", "") | default ("", true) %}
- {% if scope %}\[**{{ scope }}**\]{%endif%}{{ commit_content(commit.commit.summary) }} [\@{{ commit.commit.author.name }}](mailto:{{commit.commit.author.email}})
{% endfor %}{% endif %}{% endfor %}{% endfor %}

[codejedi365]

@ibiscp I'll let you decide if it is easy or not, but to do what you desire, you can provide your own template directory instead with a modified jinja template for both your release notes and changelog.

You will need to create a complex if statement to match the desired emoji to the commit types. Or you might be able to write a jinja macro for this.

I would first start with the embedded templates and then modify them accordingly. There is a page in the docs to describe the file structure of the templates directory.

[codejedi365]

@ibiscp, that's solid! Thanks for posting!