Struct GitHubSource 

pub struct GitHubSource { /* private fields */ }

Reads releases from a GitHub repository’s Releases.

Binary deltas (see the delta feature) are discovered by name: for the selected asset <asset>, a release asset named <asset>.from-<version>.delta is a delta from <version>. Its checksum is read from the same checksums file and its signature from <asset>.from-<version>.delta.minisig (with the configured suffix). Delta files are never picked as the main asset. With delta_history, deltas attached to earlier releases are listed too, so the engine can chain them.

use gpui_updater_core::GitHubSource;

let source = GitHubSource::new("AprilNEA", "OpenLogi")
    .asset_contains("macos")
    .asset_contains(".dmg")
    .with_checksums("SHA256SUMS")
    .with_minisig();

Implementations

impl GitHubSource

pub fn new(owner: impl Into<String>, repo: impl Into<String>) -> GitHubSource

Create a source for owner/repo, matching assets by an extension guessed from the current OS (.dmg / .exe / .tar.gz).

pub fn http(self, http: HttpOptions) -> GitHubSource

Fetch the release list and the checksums file with http’s extra headers and proxy.

pub fn asset_contains(self, substr: impl Into<String>) -> GitHubSource

Require the selected asset’s name to contain substr (case-insensitive). Call multiple times to require several substrings (e.g. macos + arm64).

pub fn asset_patterns(self, patterns: Vec<String>) -> GitHubSource

Replace the asset-matching substrings entirely.

pub fn with_checksums(self, sums_asset: impl Into<String>) -> GitHubSource

Resolve the expected SHA-256 from a checksums file asset (one <hex> <name> line per asset, as produced by shasum -a 256).

pub fn with_minisig(self) -> GitHubSource

Look for a detached minisign signature named <asset>.minisig.

pub fn signature_suffix(self, suffix: impl Into<String>) -> GitHubSource

Use a custom signature suffix instead of .minisig.

pub fn include_prereleases(self, yes: bool) -> GitHubSource

Consider pre-releases in addition to full releases.

pub fn token(self, token: impl Into<String>) -> GitHubSource

Authenticate requests with a token (private repos / rate limits).

pub fn delta_history(self, releases: usize) -> GitHubSource

Also read the deltas attached to up to releases earlier releases, so the engine can chain them when no delta starts at the installed version (publish them with delta::delta_bases). This lists releases instead of asking for /releases/latest: still one API request, covering up to 100 releases.

Trait Implementations

impl UpdateSource for GitHubSource

fn fetch_latest(&self) -> Result<Release, Error>

Fetch the latest release applicable to the running platform.