Add release documentation for the Nym wallet

2022-02-02 17:36:29 +00:00
parent a4d1d2c354
commit c37d6b9296
8 changed files with 46 additions and 1 deletions
@@ -84,4 +84,6 @@ The output will compile different types of binaries dependent on your hardware /
 |   │─  nym-wallet.exe
 └───target/release/bundle/msi
 │   │─  nym-wallet_*_.msi
-```
+```
+
+For instructions on how to release the wallet, please see [RELEASE.md](./RELEASE.md).
@@ -0,0 +1,43 @@
+# Creating a new release
+
+Go to the releases area of the Nym monoreop: https://github.com/nymtech/nym/releases.
+
+Draft a new release:
+
+![img.png](img.png)
+
+Add a new tag that starts with `nym-wallet-`:
+
+![img_1.png](img_1.png)
+
+And choose `Create new tag`.
+
+Check the branch is correct, tick `This is a pre-release` and click `Publish release`:
+
+![img_2.png](img_2.png)
+
+This will trigger the GitHub Actions that will build and sign the wallet release. Once they are done, they will upload
+any output files as assets to this release.
+
+# Troubleshooting
+
+### Rebuild?
+
+Sadly, you have to delete the release and start again. The GH Actions trigger on the creation of the release.
+
+### Oh no, I've made a mistake and need to delete everything
+
+Never fear! This is totally possible. First delete the **release** by clicking the trash icon in the top right:
+
+![img_3.png](img_3.png)
+
+Now delete the **tag** by going to tags:
+
+![img_4.png](img_4.png)
+
+Clicking on the tag header and then the trash icon:
+
+![img_5.png](img_5.png)
+
+Confirm and all is back to normal.
+