Use changelist (#22)

Author: jarrodmillman

RELEASE.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-Example `version`
+Example `version number`
 
 - 1.8.dev0 # development version of 1.8 (release candidate 1)
 - 1.8rc1 # 1.8 release candidate 1
@@ -12,21 +12,29 @@ Example `version`
 
 ## Process
 
-- Update and review `CHANGELOG.md`:
+- Set release variables:
 
-      gem install github_changelog_generator
-      github_changelog_generator -u scientific-python -p pydata --since-tag=<last tag>
+      export VERSION=<version number>
+      export PREVIOUS=<previous version number>
+      export ORG="scientific-python"
+      export REPO="devstats"
+
+- Autogenerate release notes
+
+      changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}
+
+- Put the output of the above command at the top of `CHANGELOG.md`
 
 - Update `version` in `pyproject.toml`.
 
 - Commit changes:
 
       git add pyproject.toml CHANGELOG.md
-      git commit -m 'Designate <version> release'
+      git commit -m "Designate ${VERSION} release"
 
-- Add the version number (e.g., `1.2.0`) as a tag in git:
+- Tag the release in git:
 
-      git tag -s [-u <key-id>] v<version> -m 'signed <version> tag'
+      git tag -s v${VERSION} -m "signed ${VERSION} tag"
 
   If you do not have a gpg key, use -u instead; it is important for
   Debian packaging that the tags are annotated
@@ -35,12 +43,12 @@ Example `version`
 
       git push --tags origin main
 
-  where `origin` is the name of the `github.com:scientific-python/pydata
+  where `origin` is the name of the `github.com:scientific-python/devstats`
   repository
 
 - Review the github release page:
 
-      https://github.com/scientific-python/pydata/releases
+      https://github.com/scientific-python/devstats/tags
 
 - Publish on PyPi:
 

pyproject.toml

@@ -28,7 +28,8 @@ dependencies = [
 devstats = "devstats.__main__:cli"
 
 [project.optional-dependencies]
-lint = ["pre-commit >= 3.3.2"]
+lint = ["pre-commit == 3.3.2"]
+dev = ["changelist == 0.1"]
 
 [project.urls]
 homepage = "https://github.com/scientific-python/devstats"