releasekit 0.1.0

Client-agnostic library for fetching releases from git forges
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//! Forge trait for fetching releases from git hosting platforms.

pub mod gitea;
pub mod github;
pub mod gitlab;

pub use gitea::Gitea;
pub use github::GitHub;
pub use gitlab::GitLab;

use crate::error::Result;
use crate::model::Release;

/// A git forge that can fetch releases.
///
/// Implementations wrap an [`HttpClient`](crate::client::HttpClient) and
/// translate forge-specific APIs into the common [`Release`] type.
pub trait Forge {
    /// Fetches releases for the given project.
    ///
    /// `project` is in `owner/repo` format. When `tag` is `Some`, fetches
    /// only the release for that specific tag.
    fn fetch_releases(&self, project: &str, tag: Option<&str>) -> Result<Vec<Release>>;
}