use towncrier to handle change log entries

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+> [!TIP]
+> For a public change, remember to write news fragment(s) in `changes/`:
+> - ``changes/<PR#>.apichange.rst``: change to public API
+> - ``changes/<PR#>.bugfix.rst``: fixes an issue
+> - ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
+>
+> Otherwise, add the label `no-changelog-entry-needed`. 

.github/workflows/changelog.yml

@@ -0,0 +1,30 @@
+name: changelog
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - synchronize
+      - reopened
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: pip install .
+      - run: pip install towncrier
+      - run: towncrier check
+      - run: towncrier build --draft | grep -P '#${{ github.event.number }}'

.readthedocs.yaml

@@ -20,6 +20,9 @@ build:
   os: ubuntu-22.04
   tools:
     python: mambaforge-4.10
+  jobs:
+    post_install:
+      - towncrier build --keep
 
 conda:
   environment: docs/rtd_environment.yaml

changes/.gitkeep

@@ -0,0 +1 @@
+

changes/147.general.rst

@@ -0,0 +1 @@
+use ``towncrier`` to handle change log entries

docs/index.rst

@@ -32,6 +32,7 @@ Contents
    romanisim/parameters
    romanisim/util
 
+   romanisim/changes
 
 Indices and tables
 ==================

docs/romanisim/changes.rst

@@ -0,0 +1,7 @@
+.. currentmodule:: romanisim
+
+***********
+Change  Log
+***********
+
+.. include:: ../../CHANGES.rst

docs/rtd_environment.yaml

@@ -6,3 +6,4 @@ dependencies:
  - python=3.11
  - pip
  - graphviz
+ - towncrier

pyproject.toml

@@ -132,3 +132,21 @@ extend-ignore = [
 
 [tool.cibuildwheel.macos]
 before-build = "brew install eigen fftw"
+
+[tool.towncrier]
+filename = "CHANGES.rst"
+directory = "changes"
+package = "romanisim"
+title_format = "{version} ({project_date})"
+ignore = [".gitkeep"]
+wrap = true
+issue_format = "`#{issue} <https://github.com/spacetelescope/romanisim/issues/{issue}>`_"
+
+[tool.towncrier.fragment.apichange]
+name = "Changes to API"
+
+[tool.towncrier.fragment.bugfix]
+name = "Bug Fixes"
+
+[tool.towncrier.fragment.general]
+name = "General"