Skip to content

Commit e579e63

Browse files
committed
Add release instructions for installer-downloader
1 parent e06e8b0 commit e579e63

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

installer-downloader/README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Installer downloader
2+
3+
This directory contains the source code for a minimal downloader/installer for the Mullvad VPN app.
4+
5+
## Making a release
6+
7+
This section describes how to build and release the downloader itself. Note that this is totally
8+
unrelated to releasing new versions of the Mullvad VPN app.
9+
10+
The installer is built locally and then uploaded to `app-build-linux`, which runs
11+
`buildserver-upload.sh`. `buildserver-upload.sh` will take care of GPG signing it and publishing to
12+
CDNs.
13+
14+
`<version>` below will be used below to refer to the version that is being released.
15+
16+
### Prerequisites
17+
18+
1. Install Rust if you do not have it. It can be obtained from https://rustup.rs/
19+
20+
1. You'll typically need a Windows and a macOS machine, since the installer must be built on both.
21+
22+
1. Set up macOS and Windows for signing:
23+
24+
* macOS: `CSC_LINK` must point to the path of a `.p12` certificate used for code signing.
25+
26+
* Windows: `CERT_HASH` must be set to the fingerprint of the signing certificate to use. This
27+
must be present in the certificate store.
28+
29+
See the [app release instructions](../Release.md) for more details on this.
30+
31+
1. Set up `~/.ssh/config` for `app-build-linux`. Build artifacts will be `sftp`'d here.
32+
33+
### Updating the version
34+
35+
1. Bump the version in `Cargo.toml`.
36+
37+
1. Create a signed tag called `desktop/installer-downloader/<version>` and `git push` the tag.
38+
39+
### Build and upload
40+
41+
Perform this step on both macOS and Windows:
42+
43+
1. Run `./build.sh --upload --sign`. This will build a release build of the installer and upload it
44+
to `app-build-linux:upload/installer-downloader/<version>`

0 commit comments

Comments
 (0)