Skip to content

Commit 42c25f9

Browse files
authored
Add additional special values for GitHub Releases
1 parent f5a0ab9 commit 42c25f9

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

draft.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,10 +215,23 @@ Field | Type | Example | Comments
215215
Transport mechanism | String | `gh-releases-zsync` | [zsync] file and [AppImage] **MUST** be stored on GitHub Releases
216216
GitHub username | String | `probono` | Name of the GitHub user or organization of the account where the [zsync] file and [AppImage] are stored
217217
GitHub repository | String | `AppImages` | Name of the GitHub repository in which the [zsync] file and [AppImage] are stored
218-
Release name | String | `latest` | Name of the release. `latest` will automatically use the latest release as determined by the GitHub API
218+
Release name | String | `latest` | Name of the release. See below for special values like `latest`.
219219
Filename | String | `Subsurface-*x86_64.AppImage.zsync` | Filename of the [zsync] file on GitHub, `*` is a wildcard
220220

221-
**Please note that pre-releases are not being considered when using `latest`.** You will have to explicitly provide the name of a release. When using e.g., [uploadtool](https://github.com/probonopd/uploadtool), the name of the release created will always be `continuous`, hence, you can just specify that value instead of `latest`.
221+
222+
###### *Release name* values
223+
224+
**TL;DR: pre-releases are not being considered when using `latest`.**
225+
226+
The following *special values* are supported:
227+
228+
- `latest`: Automatically detects the latest GitHub **Release**
229+
- `latest-pre`: Automatically detects the latest GitHub **Prerelease**. Useful, e.g., to implement a beta/prerelease update concept.
230+
- `latest-all`: Automatically detects the latest GitHub **Release or Prerelease**. Useful if you want prerelease users to automatically switch to a stable release until another prerelease is made.
231+
232+
Every other value is mapped to the name of a release.
233+
234+
**Note: when using a continuous release upload tool like [uploadtool](https://github.com/probonopd/uploadtool) which recreates the release during every build with the same name, e.g., `continuous`, you can also specify this name to implement a continuous update strategy.
222235

223236

224237
##### Pling/AppImageHub

0 commit comments

Comments
 (0)