Use changelist (#67)

Author: jarrodmillman

RELEASE.md

@@ -2,31 +2,39 @@
 
 ## Introduction
 
-Example `version`
+Example `version number`
 
 - 1.8.dev0 # development version of 1.8 (release candidate 1)
 - 1.8rc1 # 1.8 release candidate 1
-- 1.8rc2.dev0 # development version of 1.8 (release candidate 2)
+- 1.8rc2.dev0 # development version of 1.8 release candidate 2
 - 1.8 # 1.8 release
 - 1.9.dev0 # development version of 1.9 (release candidate 1)
 
 ## Process
 
-- Update and review `CHANGELOG.md`:
+- Set release variables:
 
-      gem install github_changelog_generator
-      github_changelog_generator -u scientific-python -p lazy_loader --since-tag=<last tag>
+      export VERSION=<version number>
+      export PREVIOUS=<previous version number>
+      export ORG="scientific-python"
+      export REPO="lazy_loader"
+
+- 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
@@ -40,7 +48,7 @@ Example `version`
 
 - Review the github release page:
 
-      https://github.com/scientific-python/lazy_loader/releases
+      https://github.com/scientific-python/lazy_loader/tags
 
 - Publish on PyPi:
 

pyproject.toml

@@ -24,7 +24,8 @@ description = "Makes it easy to load subpackages and functions on demand."
 
 [project.optional-dependencies]
 test = ["pytest >= 7.4", "pytest-cov >= 4.1"]
-lint = ["pre-commit >= 3.3"]
+lint = ["pre-commit == 3.3"]
+dev = ["changelist == 0.1"]
 
 [project.urls]
 Home = "https://scientific-python.org/specs/spec-0001/"