From 14de8c2629a1d6793fdb72e7149ad3ddc7d59acc Mon Sep 17 00:00:00 2001
From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Date: Sun, 25 Aug 2024 17:42:47 +0300
Subject: [PATCH] Add release checklist (#163)

---
 RELEASING.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 RELEASING.md

diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..998c83c
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,28 @@
+# Release Checklist
+
+- [ ] Update the
+      [`CHANGELOG.rst`](https://github.com/ofek/pypinfo/blob/master/CHANGELOG.rst)
+      and the version in
+      [`pypinfo/__init__.py`](https://github.com/ofek/pypinfo/blob/master/pypinfo/__init__.py)
+
+- [ ] Get `master` to the appropriate code release state.
+      [GitHub Actions](https://github.com/ofek/pypinfo/actions) should be running
+      cleanly for all merges to `master`.
+      [![GitHub Actions status](https://github.com/ofek/pypinfo/actions/workflows/test.yml/badge.svg)](https://github.com/ofek/pypinfo/actions/)
+
+- [ ] Create and push a tag, for example:
+
+```bash
+git tag -m 23.0.0 23.0.0
+git push --tags
+```
+
+- [ ] Check the tagged
+      [GitHub Actions build](https://github.com/ofek/pypinfo/actions/workflows/deploy.yml)
+      has deployed to [PyPI](https://pypi.org/project/pypinfo/#history)
+
+- [ ] Check installation:
+
+```bash
+pip3 uninstall -y pypinfo && pip3 install -U pypinfo && pypinfo --version
+```