Integrate towncrier into the development process

Author: olzhasar

.github/workflows/test.yml .github/workflows/ci.yml.github/workflows/test.yml renamed to .github/workflows/ci.yml

@@ -1,13 +1,9 @@
-name: Lint & test
+name: CI
 
 on:
   push:
     branches:
-      - 'main'
       - 'master'
-    paths-ignore:
-      - 'docs/**'
-      - 'README.md'
   pull_request:
   workflow_dispatch:
   workflow_call:
@@ -18,12 +14,18 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
     - name: Install uv and set the Python version
       uses: astral-sh/setup-uv@v7
       with:
         python-version: '3.10'
     - name: Run pre-commit hooks
       run: uv tool run --with pre-commit-uv pre-commit run --all-files --show-diff-on-failure --color=always
+    - name: Install towncrier
+      run: uv sync --only-group release
+    - name: Run towncrier check
+      run: uv run towncrier check --compare-with origin/${{github.event.pull_request.base.ref}}
   test:
     runs-on: ubuntu-latest
     strategy:

.github/workflows/release.yml

@@ -4,10 +4,7 @@ on:
     tags:
       - "v*.*.*"
 jobs:
-  test:
-    uses: ./.github/workflows/test.yml
   pypi:
-    needs: test
     runs-on: ubuntu-latest
     environment:
       name: pypi

.pre-commit-config.yaml

@@ -22,3 +22,8 @@ repos:
     rev: 'v1.19.1'
     hooks:
     - id: mypy
+  - repo: https://github.com/twisted/towncrier
+    rev: 23.11.0
+    hooks:
+      - id: towncrier-check
+        args: ['--dir', 'changelog.d', '--compare-with', 'origin/master']

bin/make_release

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+set -e
+
+version="$1"
+
+if [ -z "$version" ]; then
+  echo "Usage: $0 <version>"
+  exit 1
+fi
+
+if ! [[ "$version" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+  echo "Version must be in v0.0.0 format"
+  exit 1
+fi
+
+if [ -n "$(git status --porcelain)" ]; then
+  echo "Commit existing changes before proceeding with the release"
+  exit 1
+fi
+
+if ! towncrier check; then
+  echo "Nothing to release"
+  exit 1
+fi
+
+towncrier build --version "$version" --yes
+
+commit_msg="release $version"
+
+git add -A
+git commit -m "$commit_msg"
+echo "Created commit $commit_msg"
+echo "Next steps:"
+echo ""
+echo "  $ git push origin master"
+
+echo "Wait for CI to pass and then:"
+echo ""
+
+echo "  $ git tag $version"
+echo "  $ git push origin $version"

changelog.d/+towncrier.misc.md

@@ -0,0 +1 @@
+Integrate [towncrier](https://towncrier.readthedocs.io/en/stable/index.html) into the development process

changelog.d/.gitkeep

@@ -44,6 +44,9 @@ test = [
   "freezegun",
   "coverage[toml]",
 ]
+release = [
+  "towncrier",
+]
 
 [tool.hatch.version]
 source = "vcs"
@@ -64,3 +67,9 @@ lint.extend-select = ["I"]
 python_version = "3.9"
 ignore_missing_imports = true
 exclude = ".venv"
+
+[tool.towncrier]
+directory = "changelog.d"
+filename = "CHANGELOG.md"
+title_format = "## [{version}](https://github.com/olzhasar/pytest-watcher/releases/tag/{version}) - {project_date}"
+issue_format = "[#{issue}](https://github.com/olzhasar/pytest-watcher/issues/{issue})"