From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Sun, 18 Jul 2021 02:38:35 +0000 (+0200)
Subject: Add notes about making a release
X-Git-Tag: 3.0.dev2~60
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d87210e6a87e077b869be9a796c8a878f448c8e9;p=thirdparty%2Fpsycopg.git

Add notes about making a release
---

diff --git a/docs/release.rst b/docs/release.rst
new file mode 100644
index 000000000..5e8852543
--- /dev/null
+++ b/docs/release.rst
@@ -0,0 +1,36 @@
+:orphan:
+
+How to make a psycopg release
+=============================
+
+- Change version number in:
+
+  - ``psycopg_c/psycopg_c/version.py``
+  - ``psycopg/psycopg/version.py``
+
+- Push to GitHub to run `the tests workflow`__.
+
+  .. __: https://github.com/psycopg/psycopg/actions/workflows/tests.yml
+
+- Build the packages by triggering manually the `Build packages workflow`__.
+
+  .. __: https://github.com/psycopg/psycopg/actions/workflows/packages.yml
+
+- If all went fine, create a tag named after the version::
+
+    git tag -a -s 3.0.dev1
+    git push --tags
+
+- Download the ``artifacts.zip`` package from the last Packages workflow run.
+
+- Unpack the packages locally::
+
+    mkdir tmp
+    cd tmp
+    unzip ~/Downloads/artifact.zip
+
+- If the package is a testing one, upload it on TestPyPI with::
+
+    $ twine upload -s -r testpypi *
+
+- If the package is stable, omit ``-r testpypi``.