Merge pull request #1826 from zacharyburnett/changelog/towncrier

handle changelog entries with `towncrier`

.github/pull_request_template.md

@@ -29,6 +29,6 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')
 
 - [ ] pre-commit checks ran successfully
 - [ ] tests ran successfully
-- [ ] for a public change, a changelog entry was added
-- [ ] for a public change, documentation was updated
+- [ ] for a public change, added news fragment (`changes/<PR#>.<changetype>.rst`)
+- [ ] for a public change, updated documentation
 - [ ] for any new features, unit tests were added

.github/workflows/changelog.yml

@@ -1,26 +1,30 @@
-name: Changelog
+name: changelog
 
 on:
   pull_request:
-    types: [labeled, unlabeled, opened, synchronize, reopened]
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - synchronize
+      - reopened
 
-# Only cancel in-progress jobs or runs for the current workflow
-#   This cancels the already triggered workflows for a specific PR without canceling
-#   other instances of this workflow (other PRs, scheduled triggers, etc) when something
-#   within that PR re-triggers this CI
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
-  changelog:
-    name: Confirm changelog entry
+  check:
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Grep for PR number in CHANGES.rst
-        run: grep -P '\[[^\]]*#${{github.event.number}}[,\]]' CHANGES.rst
-        if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
+      - run: pip install .
+      - run: pip install towncrier
+      - run: towncrier check
+      - run: towncrier build --draft | grep -P '[\(\[][^\)\]]*#${{ github.event.number }}[,\)\]]'

.readthedocs.yaml

@@ -13,6 +13,8 @@ build:
       - git fetch --all --tags || true
     pre_install:
       - git update-index --assume-unchanged docs/rtd_environment.yaml docs/conf.py
+    post_install:
+      - towncrier build
 
 conda:
   environment: docs/rtd_environment.yaml