From 40f9ca182488fff9758ac54a32c59496da4e24e7 Mon Sep 17 00:00:00 2001
From: Tarik Havighorst <code@blurks.de>
Date: Tue, 26 Apr 2022 23:05:49 +0200
Subject: [PATCH] added RELEASING.md

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

diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..85879a4
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,43 @@
+# Releasing pynumerals
+
+- Do platform test via tox:
+  ```shell
+  tox -r
+  ```
+
+- Make sure flake8 passes:
+  ```shell
+  flake8 src
+  ```
+
+- Update the version number, by removing the trailing `.dev0` in:
+  - `setup.cfg`
+  - `src/pynumerals/__init__.py`
+
+- Create the release commit:
+  ```shell
+  git commit -a -m "release <VERSION>"
+  git push origin
+  ```
+
+- Create a release tag:
+  ```
+  gh release create
+  ```
+
+- Release to PyPI:
+  ```shell
+  rm dist/*
+  python -m build -n
+  twine upload dist/* -u __token__ -p"..."
+  ```
+
+- Change version for the next release cycle, i.e. incrementing and adding .dev0
+  - `setup.cfg`
+  - `src/pynumerals/__init__.py`
+
+- Commit/push the version change:
+  ```shell
+  git commit -a -m "bump version for development"
+  git push origin
+  ```