Skip to content

Commit 209504b

Browse files
authored
Draft GitHub Releases transport mechanism
1 parent 863389e commit 209504b

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

draft.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,24 @@ zsync file URL | String | `http://server.domain/path/Application-latest-x86_64.A
196196

197197
For an overview about [zsync] and how to create `.zsync` files, see [http://zsync.moria.org.uk/](http://zsync.moria.org.uk/).
198198

199+
##### GitHub Releases
200+
201+
The __GitHub Releases__ transport extends the [zsync] transport in that it uses version information from [GitHub Releases](https://help.github.com/articles/about-releases/). Its [update information] is in the form
202+
203+
```
204+
gh-zsync|probono|AppImages|latest|Subsurface-*-x86_64.AppImage.zsync
205+
```
206+
207+
If an [AppImage] has [update information] embedded for this transport mechanism, then the following fields **MUST** be used; separated by a "|" character:
208+
209+
Field | Type | Example | Comments
210+
----------- | ------ | -------- | --------
211+
Transport mechanism | String | `gh-zsync` | [zsync] file and [AppImage] **MUST** be stored on GitHub Releases
212+
Bintray username | String | `probono` | Name of the GitHub user or organization of the account where the [zsync] file and [AppImage] are stored
213+
Bintray repository | String | `AppImages` | Name of the GitHub repository in which the [zsync] file and [AppImage] are stored
214+
Release name | String | `latest` | Name of the release. `latest` will automatically use the latest release as determined by the GitHub API
215+
Filename | String | `Subsurface-*-x86_64.AppImage.zsync` | Filename of the [zsync] file on GitHub, `*` is a wildcard
216+
199217
##### bintray-zsync
200218

201219
The __bintray-zsync__ transport extends the [zsync] transport in that it uses version information from [Bintray](http://bintray.com/). Its [update information] is in the form

0 commit comments

Comments
 (0)