Skip to content

Commit 16836ee

Browse files
committed
first pr review updates
1 parent 75a55ec commit 16836ee

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

.github/workflows/ci.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,24 @@ jobs:
164164
run: "poetry run invoke pytest"
165165
needs:
166166
- "poetry"
167+
changelog:
168+
if: >
169+
contains(fromJson('["develop"]'), github.base_ref) &&
170+
(github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
171+
runs-on: "ubuntu-22.04"
172+
steps:
173+
- name: "Check out repository code"
174+
uses: "actions/checkout@v4"
175+
with:
176+
fetch-depth: "0"
177+
- name: "Setup environment"
178+
uses: "networktocode/gh-action-setup-poetry-environment@v6"
179+
with:
180+
poetry-version: "1.8.5"
181+
- name: "Check for changelog entry"
182+
run: |
183+
git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
184+
poetry run towncrier check --compare-with origin/${{ github.base_ref }}
167185
publish_gh:
168186
name: "Publish to GitHub"
169187
runs-on: "ubuntu-24.04"

towncrier_templates.j2

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
# v{{ versiondata.version.split(".")[:2] | join(".") }} Release Notes
3+
4+
This document describes all new features and changes in the release. 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).
5+
6+
## Release Overview
7+
8+
- Major features or milestones
9+
- Changes to compatibility with Nautobot and/or other apps, libraries etc.
10+
11+
{% if render_title %}
12+
## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/networktocode/{{ cookiecutter.project_slug }}/releases/tag/v{{ versiondata.version}})
13+
14+
{% endif %}
15+
{% for section, _ in sections.items() %}
16+
{% if sections[section] %}
17+
{% for category, val in definitions.items() if category in sections[section] %}
18+
{% if sections[section][category]|length != 0 %}
19+
### {{ definitions[category]['name'] }}
20+
21+
{% if definitions[category]['showcontent'] %}
22+
{% for text, values in sections[section][category].items() %}
23+
{% for item in text.split('\n') %}
24+
{% if values %}
25+
- {{ values|join(', ') }} - {{ item.strip() }}
26+
{% else %}
27+
- {{ item.strip() }}
28+
{% endif %}
29+
{% endfor %}
30+
{% endfor %}
31+
32+
{% else %}
33+
- {{ sections[section][category]['']|join(', ') }}
34+
35+
{% endif %}
36+
{% endif %}
37+
{% endfor %}
38+
{% else %}
39+
No significant changes.
40+
41+
{% endif %}
42+
{% endfor %}

0 commit comments

Comments
 (0)