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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# releasekit

Client-agnostic Rust library for fetching releases from git forges.

## Supported Platforms

| Platform | Status |
|----------|--------|
| GitHub   | Supported |
| GitLab   | Supported |
| Codeberg | Supported (via Gitea) |
| Gitea    | Supported |

## Quick Start

```rust
use releasekit::platform::GitHub;
use releasekit::client::UreqClient;
use releasekit::Forge;

let gh = GitHub::new(UreqClient)
    .with_token_from_env(&["GITHUB_TOKEN", "GH_TOKEN"]);

let releases = gh.fetch_releases("owner/repo", None).unwrap();
for r in &releases {
    println!("{} — {} assets", r.tag(), r.assets().len());
}
```

## Platforms

### GitHub

```rust
use releasekit::platform::GitHub;
use releasekit::client::UreqClient;
use releasekit::Forge;

let gh = GitHub::new(UreqClient)
    .with_token_from_env(&["GITHUB_TOKEN", "GH_TOKEN"]);

// GitHub Enterprise or API proxy
let gh = GitHub::new(UreqClient)
    .with_base_url("https://github.example.com/api/v3");
```

### GitLab

```rust
use releasekit::platform::GitLab;
use releasekit::client::UreqClient;
use releasekit::Forge;

let gl = GitLab::new(UreqClient)
    .with_token_from_env(&["GITLAB_TOKEN", "GL_TOKEN"]);

// Self-hosted GitLab
let gl = GitLab::new(UreqClient)
    .with_base_url("https://gitlab.example.com");

// Numeric project ID
let releases = gl.fetch_releases("12345", None).unwrap();
```

### Gitea / Codeberg

```rust
use releasekit::platform::Gitea;
use releasekit::client::UreqClient;
use releasekit::Forge;

// Codeberg
let cb = Gitea::new(UreqClient, "https://codeberg.org")
    .with_token_from_env(&["CODEBERG_TOKEN"]);

// Self-hosted Gitea
let gt = Gitea::new(UreqClient, "https://gitea.example.com")
    .with_token_from_env(&["GITEA_TOKEN"]);
```

## Asset Filtering

```rust
use releasekit::Filter;

let filter = Filter::new()
    .glob("*.AppImage")
    .include("x86_64")
    .exclude("debug");

for asset in release.assets() {
    if filter.matches(asset.name()) {
        println!("{}", asset.url());
    }
}
```

## Custom HTTP Backend

releasekit uses a trait-based HTTP client. Implement `HttpClient` to use your own backend:

```rust
use releasekit::client::{HttpClient, HeaderMap, Response};

#[derive(Clone)]
struct MyClient;

impl HttpClient for MyClient {
    fn get(&self, url: &str, headers: &HeaderMap) -> releasekit::error::Result<Response> {
        // your implementation
        todo!()
    }
}
```

A built-in `UreqClient` is available with the `ureq` feature (enabled by default).

## Examples

```bash
cargo run --example github -- owner/repo
cargo run --example gitlab -- owner/repo
cargo run --example gitea -- https://codeberg.org/owner/repo
```

## License

MIT