From 267cb8db6302b0c1d55a500fb1dc2cee68d97a30 Mon Sep 17 00:00:00 2001 From: Hedde van der Heide Date: Wed, 5 Jan 2022 09:41:54 +0100 Subject: [PATCH] added release guide --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7646de3..5afeac8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,18 @@ PLUGINS = [ ### Releasing Guide -_TODO_ +To draft a release; + +update the setup.py file to reflect the new version, then from the *src* directory run + +``` +$ python setup.py sdist +$ twine upload dist/* +``` + +On Github.com create a similar tag and version. These steps could be automated with a github workflow. + +n.b. Currently the plugin is configured to use a personal pypi account, this should be changed. ### Developer Guide (local installation)