remove towncrier as changelog handler

The project will use Automatically generated release notes from now on
fschuch · Jun 5, 2024 · 449f3b6 · 449f3b6
1 parent ff27fed
commit 449f3b6
Show file tree

Hide file tree

Showing 14 changed files with 51 additions and 181 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,31 @@
+changelog:
+  categories:
+    - title: Security
+      labels:
+        - security
+    - title: Removed
+      labels:
+        - removed
+    - title: Deprecated
+      labels:
+        - deprecated
+    - title: Added
+      labels:
+        - added
+    - title: Changed
+      labels:
+        - changed
+    - title: Fixed
+      labels:
+        - fixed
+    - title: Documentation
+      labels:
+        - docs
+    - title: Internals
+      labels:
+        - chore
+        - refactor
+        - dependencies
+    - title: Other Changes
+      labels:
+        - "*"
diff --git a/.github/workflows/1-prepare-release.yaml b/.github/workflows/1-prepare-release.yaml
diff --git a/.github/workflows/2-tag-release.yaml b/.github/workflows/2-tag-release.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ To ensure code quality, several tools are suggested and pre-configured:
 - [ruff](https://github.com/astral-sh/ruff) as the linter and code formatter
 - [codespell](https://github.com/codespell-project/codespell) to check spelling
 - [pytest](https://docs.pytest.org/en/7.4.x/) as the test engine
-- [towncrier](https://towncrier.readthedocs.io/en/stable/index.html) handles the changelog file
+- [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) from GitHub to handle the changelog
 
 In addition, [Git hooks](https://pre-commit.com/) can be used to guarantee consistency and leverage the aforementioned tools. The workflow [test-package.yaml](.github/workflows/test-package.yaml) runs them automatically for you.
 
@@ -38,29 +38,24 @@ You can check at anytime the environments and scripts that are prepared to suppo
 
 ```plain
 $ hatch env show --ascii
-                                           Standalone
-+-----------+---------+------------------+----------------------+------------------------------+
-| Name      | Type    | Dependencies     | Scripts              | Description                  |
-+===========+=========+==================+======================+==============================+
-| default   | virtual | coverage[toml]   | check                | Base development environment |
-|           |         | pre-commit       | format               |                              |
-|           |         | pytest           | lint                 |                              |
-|           |         | pytest-cov       | pre-commit-install   |                              |
-|           |         |                  | pre-commit-uninstall |                              |
-|           |         |                  | qa                   |                              |
-|           |         |                  | test                 |                              |
-|           |         |                  | test-no-cov          |                              |
-|           |         |                  | type                 |                              |
-+-----------+---------+------------------+----------------------+------------------------------+
-| docs      | virtual | docutils         | build                | Documentation environment    |
-|           |         | jupyter-book     | config               |                              |
-|           |         | sphinx-autobuild | serve                |                              |
-+-----------+---------+------------------+----------------------+------------------------------+
-| changelog | virtual | towncrier        | build                | Changelog handler            |
-|           |         |                  | check                |                              |
-|           |         |                  | create               |                              |
-|           |         |                  | draft                |                              |
-+-----------+---------+------------------+----------------------+------------------------------+
+                                          Standalone
++---------+---------+------------------+----------------------+------------------------------+
+| Name    | Type    | Dependencies     | Scripts              | Description                  |
++=========+=========+==================+======================+==============================+
+| default | virtual | coverage[toml]   | check                | Base development environment |
+|         |         | pre-commit       | format               |                              |
+|         |         | pytest           | lint                 |                              |
+|         |         | pytest-cov       | pre-commit-install   |                              |
+|         |         |                  | pre-commit-uninstall |                              |
+|         |         |                  | qa                   |                              |
+|         |         |                  | test                 |                              |
+|         |         |                  | test-no-cov          |                              |
+|         |         |                  | type                 |                              |
++---------+---------+------------------+----------------------+------------------------------+
+| docs    | virtual | docutils         | build                | Documentation environment    |
+|         |         | jupyter-book     | config               |                              |
+|         |         | sphinx-autobuild | serve                |                              |
++---------+---------+------------------+----------------------+------------------------------+
                                                  Matrices
 +------+---------+-------------+----------------------+----------------------+---------------------------+
 | Name | Type    | Envs        | Dependencies         | Scripts              | Description               |

diff --git a/changelog.d/+26504d7b.added.md b/changelog.d/+26504d7b.added.md
diff --git a/changelog.d/+372e2893.changed.md b/changelog.d/+372e2893.changed.md
diff --git a/changelog.d/+437da835.added.md b/changelog.d/+437da835.added.md
diff --git a/changelog.d/+801234df.changed.md b/changelog.d/+801234df.changed.md
diff --git a/changelog.d/+b04ee6f1.added.md b/changelog.d/+b04ee6f1.added.md
diff --git a/changelog.d/+ff95a66f.removed.md b/changelog.d/+ff95a66f.removed.md
diff --git a/changelog.d/README.md b/changelog.d/README.md
diff --git a/hatch.toml b/hatch.toml
@@ -35,6 +35,7 @@ python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 description = "Documentation environment"
 template = "docs"
 install = true
+installer = "uv"
 dependencies = ["docutils", "jupyter-book", "sphinx-autobuild"]
 
 [envs.docs.scripts]
@@ -44,15 +45,3 @@ serve = [
     "config",
     "sphinx-autobuild docs build/_build/html --open-browser --watch wizard_template {args}",
 ]
-
-[envs.changelog]
-description = "Changelog handler"
-dependencies = ["towncrier"]
-template = "changelog"
-install = true
-
-[envs.changelog.scripts]
-build = "towncrier build {args}"
-draft = "build --draft {args}"
-create = "towncrier create {args}"
-check = "towncrier check {args}"
diff --git a/towncrier.toml b/towncrier.toml