Skip to content

Commit

Permalink
ci: Add custom template for release notes to follow changelog structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBavenstrand committed Jan 26, 2024
1 parent 5e795cd commit 30518c0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions templates/.release_notes.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# [{{ version.as_tag() }}](https://github.com/{{ context.repo_owner|urlencode }}/{{ context.repo_name|urlencode }}/releases/tag/{{ version.as_tag()|urlencode }}) ({{ release.tagged_date.strftime("%Y-%m-%d") }})
{% for commit_type, heading in (("breaking", "⛔️ BREAKING CHANGES"), ("feat", "✨ Features"), ("fix", "🐛 Bug Fixes"), ("perf", "🚀 Performance improvements"), ("refactor", "🛠️ Code Refactoring"), ("style", "🎨 Style"), ("docs", "📝 Documentation"), ("test", "🧪 Tests"), ("build", "🏗️ Build"), ("ci", "🤖 Continous Integration")) if commit_type in release["elements"] %}
## {{ heading }}

{% for commit in release["elements"][commit_type] -%}
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}{{ commit.descriptions[0] }} ([`{{ commit.short_hash }}`]({{ commit.hexsha|commit_hash_url }}))
{% endfor %}{% endfor %}

0 comments on commit 30518c0

Please sign in to comment.