obsidian-export/changelog.d/template.md
Nick Groenen 72735cfff8
Change release process to use towncrier and delay regenerating README
1. Use [towncrier][1] to generate release notes/CHANGELOG instead of
   auto-generating it from git commit messages.
2. Move release scripts into a Justfile.
3. Only regenerate the top-level README file when making a release,
   don't force it to be up to date in between releases.

Point 3 helps prevent documentation for unreleased changes from being
shown to users on GitHub, which may otherwise be confusing.

[1]: https://towncrier.readthedocs.io/en/stable/index.html#
2024-08-04 14:19:50 +02:00

1.0 KiB

{% if render_title %}

v{{ versiondata.version }} ({{ versiondata.date }})

{% endif %} {% for section, _ in sections.items() %} {% if section %}

{{section}}

{% endif %}

{% if sections[section] %} {% for category, val in definitions.items() if category in sections[section] %}

{{ definitions[category]['name'] }}

{% for text, values in sections[section][category].items() %}

  • {{ text }} {%- if values %} {% if "\n - " in text or '\n * ' in text %}

    ( {%- else %} {% if text %} ({% endif %} {%- endif -%} {%- for issue in values %} {{ issue.split(": ", 1)[0] }}{% if not loop.last %}, {% endif %} {%- endfor %} {% if text %}){% endif %}

{% else %}

{% endif %} {% endfor %}

{% if issues_by_category[section][category] and "]: " in issues_by_category[section][category][0] %} {% for issue in issues_by_category[section][category] %} {{ issue }} {% endfor %}

{% endif %} {% if sections[section][category]|length == 0 %} No significant changes.

{% else %} {% endif %} {% endfor %} {% else %} No significant changes.

{% endif %} {% endfor +%}