aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2023-10-20 18:26:07 -0700
committerMicah Lee <micah@micahflee.com>2023-10-20 18:26:07 -0700
commit982b0f857ea9e4741b51c66b4d573f6331438a86 (patch)
tree8a2992ec368c1c8d51be8c24ee619b07da352b09
parentd8d936b9fa02fc138a752baea1e054f371e61402 (diff)
downloadonionshare-982b0f857ea9e4741b51c66b4d573f6331438a86.tar.gz
onionshare-982b0f857ea9e4741b51c66b4d573f6331438a86.zip
Update release documentation to include notes about deleting old build/dist before starting a new release, and more detailed instructions on setting up VMs
-rw-r--r--RELEASE.md35
-rw-r--r--desktop/README.md4
2 files changed, 35 insertions, 4 deletions
diff --git a/RELEASE.md b/RELEASE.md
index 5d4ccfe9..035dd3f8 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -160,12 +160,32 @@ From https://snapcraft.io/onionshare/releases (you must be logged in), promote t
### Windows release
-Set up the packaging environment:
+Create a Windows 11 VM, and set it up like this:
+- Install [git for Windows](https://git-scm.com/download/win).
+- Install the latest version of 3.11 [from python.org](https://www.python.org/downloads/).
+- Install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), making sure to check "Desktop development with C++".
+- Download and install [7-Zip (x64)](https://7-zip.org/). Add `C:\Program Files\7-Zip` to your path.
+- Download and install [gpg4win](https://gpg4win.org/). Add `C:\Program Files (x86)\GnuPG\bin` to your path.
- Install the Windows SDK from here: https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/.
- Go to https://dotnet.microsoft.com/download/dotnet-framework and download and install .NET Framework 3.5 SP1 Runtime. I downloaded `dotnetfx35.exe`.
- Go to https://wixtoolset.org/docs/wix3/ and download and install WiX toolset. I downloaded `wix311.exe`. Add `C:\Program Files (x86)\WiX Toolset v3.11\bin` to the path.
+Clone the OnionShare git repo and checkout the release tag.
+
+If you've used this git repo for a previous release, clean it up:
+
+- In the `onionshare/desktop` folder, delete `build` and `dist` from the previous build.
+- Delete the poetry environment. You can find its name by run `poetry env list`, and then you can delete it with `poetry env remove [ENV_NAME]`.
+
+Install Poetry and deps. Open a Developer PowerShell for VS window, change to the `onionshare` folder, and run:
+
+```powershell
+cd desktop
+pip install poetry
+poetry install
+```
+
Github Actions will build the binaries. Find the Github Actions `build` workflow, switch to the summary tab, download `win64-build.zip`, and copy it to the Windows packaging environment.
Extract `win64-build.zip`. Run:
@@ -191,7 +211,18 @@ Set up the VM like this:
- Install ARM64 version of Go from https://go.dev/dl/
- Install "Postgres.app with PostgreSQL 14 (Universal)" from https://postgresapp.com/downloads.html
-After cloning the OnionShare git repo and checking out the release branch, install and build dependencies:
+Clone the OnionShare git repo and checkout the release tag.
+
+If you've used this git repo for a previous release, clean it up:
+
+```sh
+cd desktop
+rm -rf build dist
+# Delete the old poetry environment
+poetry env remove $(poetry env list | grep "(Activated)" | cut -d" " -f1)
+```
+
+Install and build dependencies:
```sh
cd desktop
diff --git a/desktop/README.md b/desktop/README.md
index 5814f08f..dbb2d7be 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -32,8 +32,8 @@ poetry install
- On Fedora/CentOS you may need the `libxcb-*` and `xcb-util-*` packages installed.
**Windows users:**
-- Download and install 7-Zip (x64) from https://7-zip.org/download.html. [Add](https://medium.com/@kevinmarkvi/how-to-add-executables-togit fethc-your-path-in-windows-5ffa4ce61a53) `C:\Program Files\7-Zip` to your path.
-- Download and install gpg4win from https://gpg4win.org/. Add `C:\Program Files (x86)\GnuPG\bin` to your path too.
+- Download and install [7-Zip (x64)](https://7-zip.org/). Add `C:\Program Files\7-Zip` to your path.
+- Download and install [gpg4win](https://gpg4win.org/). Add `C:\Program Files (x86)\GnuPG\bin` to your path.
Download Tor Browser and extract the binaries for your platform. The platform must be `win64`, `macos`, or `linux64`.