Merge pull request #26 from Project-OMOTES/25-update-readme-on-using-…

…github-releases-to-publish-to-pypi-and-npm-and-change-python-publish-to-run-on-github-release

25: Release Github actions should act on a Github release and not on …

.github/workflows/node_release.yml

@@ -1,8 +1,8 @@
 name: NPM Publish
+run-name: Releasing next version on NPM 🚀
 on:
-  push:
-    tags:
-      - "*"
+  release:
+    types: [published]
 
 jobs:
   npm-publish:

.github/workflows/python_release.yml

@@ -1,9 +1,8 @@
 name: PyPi release
-run-name: Releasing next version 🚀
+run-name: Releasing next version on PyPI 🚀
 on:
-  push:
-    tags:
-      - '*'
+  release:
+    types: [published]
 
 jobs:
   pypi-publish:

README.md

@@ -30,5 +30,18 @@ A number of tools are available to create the Python package:
   messages.
 
 # TypeScript-specific implementation Developers Guide
-To build the TypeScript artifacts, navigate to `/typescript` and run `npm run build`. Versioning is done automatically
-through the corresponding GitHub action (see [node_release.yml](./.github/workflows/node_release.yml)).
+To build the TypeScript artifacts, navigate to `./typescript` and run `npm run build`. Versioning is done automatically
+through the corresponding GitHub action (see [node_release.yml](./.github/workflows/node_release.yml)).
+
+# Release
+Releases are generated by creating and publishing a release on Github. This ensures that release
+notes are generated as well and that a tag exists with the accompanying release.
+
+Steps to release:
+- Draft a new release [here](https://github.com/Project-OMOTES/omotes-sdk-protocol/releases/new)
+  - Create a new tag by typing the version number in 'Choose a tag'
+  - Select the previous tag (previous auto tag isn't always correct)
+  - Click 'Generate release notes'
+  - Check if the release notes make sense.
+  - Check if 'Set as latest release' should be enabled.
+  - Click 'Publish Release' at the bottom of the page.