Add towncrier check in the CI (#329)

* Add towncrier check in the CI

* add the changelog message to pass CI and validate change

Author: chadell

.github/workflows/ci.yml

@@ -192,6 +192,24 @@ jobs:
           GH_TOKEN: "${{ secrets.NTC_GITHUB_TOKEN }}"
     needs:
       - "pytest"
+  changelog:
+    if: >
+      contains(fromJson('["develop"]'), github.base_ref) &&
+      (github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
+    runs-on: "ubuntu-22.04"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v4"
+        with:
+          fetch-depth: "0"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
+      - name: "Check for changelog entry"
+        run: |
+          git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
+          poetry run towncrier check --compare-with origin/${{ github.base_ref }}
   publish_pypi:
     name: "Push Package to PyPI"
     runs-on: "ubuntu-24.04"

changes/329.housekeeping

@@ -0,0 +1 @@
+Add changelog check in the CI

poetry.lock

@@ -58,6 +58,7 @@ types-pytz = "^2022.0.0"
 types-toml = "^0.10.1"
 netconan = "^0.12.3"
 toml = "0.10.2"
+towncrier = "^24.8.0"
 types-chardet = "^5.0.4"
 pandas-stubs = "2.2.2.240603"
 coverage = "^7.6.12"
@@ -144,7 +145,7 @@ addopts = "-vv --doctest-modules -p no:warnings --ignore-glob='*mock*'"
 package = "circuit_maintenance_parser"
 directory = "changes"
 filename = "docs/release_notes.md"
-template = "changes/towncrier_template.j2"
+template = "towncrier_template.j2"
 start_string = "<!-- towncrier release notes start -->"
 issue_format = "[#{issue}](https://github.com/networktocode/circuit_maintenance_parser/issues/{issue})"
 

pyproject.toml

@@ -0,0 +1,42 @@
+
+# v{{ versiondata.version.split(".")[:2] | join(".") }} Release Notes
+
+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).
+
+## Release Overview
+
+- Major features or milestones
+- Changes to compatibility with Nautobot and/or other apps, libraries etc.
+
+{% if render_title %}
+## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/networktocode/circuit_maintenance_parser/releases/tag/v{{ versiondata.version}})
+
+{% endif %}
+{% for section, _ in sections.items() %}
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section] %}
+{% if sections[section][category]|length != 0 %}
+### {{ definitions[category]['name'] }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+{% for item in text.split('\n') %}
+{% if values %}
+- {{ values|join(', ') }} - {{ item.strip() }}
+{% else %}
+- {{ item.strip() }}
+{% endif %}
+{% endfor %}
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% endif %}
+{% endfor %}
+{% else %}
+No significant changes.
+
+{% endif %}
+{% endfor %}