@@ -11,11 +11,11 @@ desktop app for Linux and Windows platforms
11
11
12
12
### Types of releases
13
13
14
- Release tags must follow the following patterns:
14
+ Release tags must follow the following patterns depending on the release type :
15
15
16
16
- ** stable** ` nym-vpn-app-v1.2.3 `
17
- - dev ` nym-vpn-app-v1.2.3-dev `
18
- - RC ` nym-vpn-app-v1.2.3-rc.1 `
17
+ - dev: ` nym-vpn-app-v1.2.3-dev ` , ` nym-vpn-app-v1.2.3-rc ` for RC or
18
+ ` nym-vpn-app-v1.2.3-beta ` for beta builds
19
19
- nightly ` nym-vpn-app-nightly `
20
20
21
21
### Bump versions
@@ -51,12 +51,7 @@ version = ">=1.2.0"
51
51
52
52
---
53
53
54
- There are 2 ways to release the app:
55
-
56
- 1 . manually from the GH workflow, recommended for now
57
- 2 . via git tag (_ TODO_ )
58
-
59
- ### Trigger the release manually
54
+ ### Trigger the release
60
55
61
56
Go to the workflow
62
57
[ publish-nym-vpn-app] ( https://github.com/nymtech/nym-vpn-client/actions/workflows/publish-nym-vpn-app.yml )
@@ -69,22 +64,36 @@ and click on the _Run workflow_ button
69
64
70
65
** NOTE** refer to the [ types of releases] ( #types-of-releases ) section
71
66
72
- 3 . : warning : if it is ** not ** a stable release check the _ Pre-release _ tickbox
67
+ 3 . select the release type
73
68
74
- 4 . check the _ dev_ tickbox if it is a dev release, not stable, \
75
- (enable in-app dev menu)
69
+ - ** stable** for a stable public release
70
+ - ** dev** for a development release, like RC, beta etc
71
+ - ** nightly** for a nightly build (not really used)
76
72
77
- 5 . in the _ nym-vpn-core release tag_ input, enter the core release \
78
- tag that this app release targets, e.g. ` nym-vpn-core-v1.2.3 `
73
+ 4 . if ** not** a stable release, you may want to label it as _ Pre-release_
79
74
80
- 6 . click the green _ Run workflow_ button
75
+ 5 . check _ Enable updater_ if you want to enable the in-app updater (Windows only) \
76
+ this is recommended for stable releases \
77
+ if you check this:
81
78
82
- If the release job is successful, the release has been published \
83
- -> https://github.com/nymtech/nym-vpn-client/releases
79
+ - the app will check for updates on startup, and if there is one available, it will prompt the user to update
80
+ - it will create a PR to bump the updater JSON metadata
81
+ - at build time, it will generate the bundle signature
82
+
83
+ 6 . check the _ dev_ tickbox if it is a dev release, ** not stable** , \
84
+ and you want to enable the in-app dev menu
84
85
85
- ### Trigger the release via a git tag
86
+ 7 . For stable releases, in the "nym-vpn-core release tag" input, enter the GH core release \
87
+ tag that this app release targets, e.g. ` nym-vpn-core-v1.2.3 ` \
88
+ For dev releases, instead you can use any core dev builds using direct link to the Windows zip archive \
89
+ just copy the url into the "direct nym-vpn-core artifact URL" input
86
90
87
- _ TODO_
91
+ e.g. ` https://buildsci.nym.anon/nym-vpn-client/nym-vpn-core/develop/123/nym-vpn-core-v1.2.3-beta.123_windows_x86_64.zip `
92
+
93
+ 8 . click the green _ Run workflow_ button
94
+
95
+ If the release job is successful, the release has been published \
96
+ -> https://github.com/nymtech/nym-vpn-client/releases
88
97
89
98
---
90
99
@@ -102,7 +111,8 @@ on new stable, the rest of the packages need to be updated manually.
102
111
103
112
- refer to [ update AUR] ( update_aur.md ) for Arch Linux packages
104
113
- refer to [ update Flatpak] ( update_flatpak.md ) for Flatpak package
105
- - refer to [ update Linux installer] ( update_linux_installer.md ) for Linux installer script
114
+ - refer to [ update Linux installer] ( update_linux_installer.md ) for Linux
115
+ installer script
106
116
107
117
#### nym.com
108
118
0 commit comments