Skip to content

Add additional special values for GitHub Releases #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2025
Merged

Add additional special values for GitHub Releases #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions draft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,23 @@ Field | Type | Example | Comments
Transport mechanism | String | `gh-releases-zsync` | [zsync] file and [AppImage] **MUST** be stored on GitHub Releases
GitHub username | String | `probono` | Name of the GitHub user or organization of the account where the [zsync] file and [AppImage] are stored
GitHub repository | String | `AppImages` | Name of the GitHub repository in which the [zsync] file and [AppImage] are stored
Release name | String | `latest` | Name of the release. `latest` will automatically use the latest release as determined by the GitHub API
Release name | String | `latest` | Name of the release. See below for special values like `latest`.
Filename | String | `Subsurface-*x86_64.AppImage.zsync` | Filename of the [zsync] file on GitHub, `*` is a wildcard

**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`.

###### *Release name* values

**TL;DR: pre-releases are not being considered when using `latest`.**

The following *special values* are supported:

- `latest`: Automatically detects the latest GitHub **Release**
- `latest-pre`: Automatically detects the latest GitHub **Prerelease**. Useful, e.g., to implement a beta/prerelease update concept.
- `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.

Every other value is mapped to the name of a release.

**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, e.g., the name `continuous` to implement a continuous update strategy which always checks the same GitHub release.


##### Pling/AppImageHub
Expand Down