From 1f0052a6bd41e5b970111d4fdb31044416d99fc3 Mon Sep 17 00:00:00 2001
From: Jarrod Millman <jarrod.millman@gmail.com>
Date: Sun, 2 Jul 2023 17:51:39 -0700
Subject: [PATCH] Use changelist (#61)

---
 RELEASE.md     | 24 ++++++++++++++++--------
 pyproject.toml |  3 ++-
 2 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/RELEASE.md b/RELEASE.md
index 9b8c47a..2c414a7 100644
--- a/RELEASE.md
+++ b/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 yaml2ics --since-tag=<last tag>
+      export VERSION=<version number>
+      export PREVIOUS=<previous version number>
+      export ORG="scientific-python"
+      export REPO="yaml2ics"
+
+- 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/yaml2ics/releases
+      https://github.com/scientific-python/yaml2ics/tags
 
 - Publish on PyPi:
 
diff --git a/pyproject.toml b/pyproject.toml
index 22ac6e3..8e9380f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -28,7 +28,8 @@ dependencies = [
 
 [project.optional-dependencies]
 test = ["pytest >= 7.3", "pytest-cov >= 4.0"]
-lint = ["pre-commit >= 3.0"]
+lint = ["pre-commit == 3.0"]
+dev = ["changelist == 0.1"]
 
 [project.scripts]
 yaml2ics = "yaml2ics:cli"