diff --git a/nym-wallet/README.md b/nym-wallet/README.md index ea80f281b7..aa6e25cb35 100644 --- a/nym-wallet/README.md +++ b/nym-wallet/README.md @@ -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 -``` \ No newline at end of file +``` + +For instructions on how to release the wallet, please see [RELEASE.md](./RELEASE.md). \ No newline at end of file diff --git a/nym-wallet/docs/release/RELEASE.md b/nym-wallet/docs/release/RELEASE.md new file mode 100644 index 0000000000..f6693145f1 --- /dev/null +++ b/nym-wallet/docs/release/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. + diff --git a/nym-wallet/docs/release/img.png b/nym-wallet/docs/release/img.png new file mode 100644 index 0000000000..82376d0c24 Binary files /dev/null and b/nym-wallet/docs/release/img.png differ diff --git a/nym-wallet/docs/release/img_1.png b/nym-wallet/docs/release/img_1.png new file mode 100644 index 0000000000..091daf2a76 Binary files /dev/null and b/nym-wallet/docs/release/img_1.png differ diff --git a/nym-wallet/docs/release/img_2.png b/nym-wallet/docs/release/img_2.png new file mode 100644 index 0000000000..e169ef12d0 Binary files /dev/null and b/nym-wallet/docs/release/img_2.png differ diff --git a/nym-wallet/docs/release/img_3.png b/nym-wallet/docs/release/img_3.png new file mode 100644 index 0000000000..2bc935bbcc Binary files /dev/null and b/nym-wallet/docs/release/img_3.png differ diff --git a/nym-wallet/docs/release/img_4.png b/nym-wallet/docs/release/img_4.png new file mode 100644 index 0000000000..5cea1a5d96 Binary files /dev/null and b/nym-wallet/docs/release/img_4.png differ diff --git a/nym-wallet/docs/release/img_5.png b/nym-wallet/docs/release/img_5.png new file mode 100644 index 0000000000..2b4f541e99 Binary files /dev/null and b/nym-wallet/docs/release/img_5.png differ