Merge branch 'main' into multiple-summaries

.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 

.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         name: Install Python
         with:
           python-version: "3.11"

README.md

@@ -1,19 +1,15 @@
 # changelist
 
-Changelist helps you write better release notes by automating as much of the
-process as possible. For example, see
+A tool that automates release note generation.
+
+For example, see
 https://github.com/scientific-python/changelist/blob/main/CHANGELOG.md.
 
 **Features**
 
-- Compile a list of pull requests, code authors and reviewers between any two
-  valid Git objects (refs).
+- Compile a list of pull requests, code authors, and reviewers between
+  two given git commits.
 - Categorize pull requests into sections based on GitHub labels.
-- Point it at any repository on GitHub. No need to clone or checkout a
-  repository locally, a Python package is all that's needed.
-
-We recommend to treat the generated document as a first draft to build
-on and not as an already perfect documentation of the release.
 
 _This project is currently in its alpha stage and might be incomplete or change a lot!_
 

pyproject.toml

@@ -33,7 +33,7 @@ dependencies = [
 changelist = "changelist.__main__:main"
 
 [project.optional-dependencies]
-lint = ["pre-commit == 3.5.0"]
+lint = ["pre-commit == 3.6.0"]
 test = ["pytest", "pytest-cov"]
 
 [tool.ruff]