From df8fca0122f6d85dcda9e14df8c65907b6e0cd7d Mon Sep 17 00:00:00 2001
From: Bryan Newbold <bnewbold@archive.org>
Date: Mon, 25 Oct 2021 17:08:52 -0700
Subject: start a changelog, and document release process

---
 CHANGELOG.md      |  6 ++++++
 HOWTO_release.txt | 17 +++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 HOWTO_release.txt

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..35d9f80
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,6 @@
+
+# CHANGELOG
+
+## [0.1.0] - 2021-10-25
+
+Initial public release.
diff --git a/HOWTO_release.txt b/HOWTO_release.txt
new file mode 100644
index 0000000..79ee5b0
--- /dev/null
+++ b/HOWTO_release.txt
@@ -0,0 +1,17 @@
+
+Steps to cut a new release.
+
+Final prep:
+
+- `make fmt lint test`
+- commit any last changes or cleanups
+- update CHANGELOG with a version entry
+- increment version number in `grobid_tei_xml/__init__.py`
+- re-run tests, commit
+- `git status`: ensure working directory is clean
+
+tag, push, upload:
+
+- `git tag vX.Y.Z -a -s -u bnewbold@archive.org -m "grobid_tei_xml release X.Y.Z"`
+- `git push`, `git push --tags`
+- `python3 setup.py upload` (ensure `bnewbold-archive` account)
-- 
cgit v1.2.3