added release guide

2022-01-05 09:41:54 +01:00
parent 4a92e96f2d
commit 267cb8db63
1 changed files with 12 additions and 1 deletions
@@ -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)