octocrab 0.54.7

A modern, extensible GitHub API client.
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
use crate::{actions::ActionsHandler, models::RunnerGroupId};
use serde::Serialize;

enum RunnerScope {
    Org(String),
    Repo { owner: String, repo: String },
}

/// A builder pattern struct for listing self-hosted runners.
///
/// Created by [`ActionsHandler::list_org_self_hosted_runners`] or
/// [`ActionsHandler::list_repo_self_hosted_runners`].
///
/// [`ActionsHandler::list_org_self_hosted_runners`]: ../struct.ActionsHandler.html#method.list_org_self_hosted_runners
/// [`ActionsHandler::list_repo_self_hosted_runners`]: ../struct.ActionsHandler.html#method.list_repo_self_hosted_runners
#[derive(Serialize)]
pub struct ListSelfHostedRunnersBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r ActionsHandler<'octo>,
    #[serde(skip)]
    scope: RunnerScope,
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    per_page: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    page: Option<u32>,
}

impl<'octo, 'r> ListSelfHostedRunnersBuilder<'octo, 'r> {
    pub(crate) fn new_org(handler: &'r ActionsHandler<'octo>, org: String) -> Self {
        Self {
            handler,
            scope: RunnerScope::Org(org),
            name: None,
            per_page: None,
            page: None,
        }
    }

    pub(crate) fn new_repo(
        handler: &'r ActionsHandler<'octo>,
        owner: String,
        repo: String,
    ) -> Self {
        Self {
            handler,
            scope: RunnerScope::Repo { owner, repo },
            name: None,
            per_page: None,
            page: None,
        }
    }

    /// Filter the list by runners matching the given name.
    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = Some(name.into());
        self
    }

    /// Results per page (max 100).
    pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
        self.per_page = Some(per_page.into());
        self
    }

    /// Page number of the results to fetch.
    pub fn page(mut self, page: impl Into<u32>) -> Self {
        self.page = Some(page.into());
        self
    }

    /// Sends the actual request.
    pub async fn send(
        self,
    ) -> crate::Result<crate::Page<crate::models::actions::SelfHostedRunner>> {
        let route = match &self.scope {
            RunnerScope::Org(org) => format!("/orgs/{org}/actions/runners"),
            RunnerScope::Repo { owner, repo } => format!("/repos/{owner}/{repo}/actions/runners"),
        };

        self.handler.crab.get(route, Some(&self)).await
    }
}

/// A builder pattern struct for creating just-in-time runner configurations.
///
/// Created by [`ActionsHandler::create_org_jit_runner_config`] or
/// [`ActionsHandler::create_repo_jit_runner_config`].
///
/// [`ActionsHandler::create_org_jit_runner_config`]: ../struct.ActionsHandler.html#method.create_org_jit_runner_config
/// [`ActionsHandler::create_repo_jit_runner_config`]: ../struct.ActionsHandler.html#method.create_repo_jit_runner_config
#[derive(Serialize)]
pub struct CreateJitRunnerConfigBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r ActionsHandler<'octo>,
    #[serde(skip)]
    scope: RunnerScope,
    name: String,
    runner_group_id: RunnerGroupId,
    labels: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    work_folder: Option<String>,
}

impl<'octo, 'r> CreateJitRunnerConfigBuilder<'octo, 'r> {
    pub(crate) fn new_org(
        handler: &'r ActionsHandler<'octo>,
        org: String,
        name: String,
        runner_group_id: RunnerGroupId,
        labels: Vec<String>,
    ) -> Self {
        Self {
            handler,
            scope: RunnerScope::Org(org),
            name,
            runner_group_id,
            labels,
            work_folder: None,
        }
    }

    pub(crate) fn new_repo(
        handler: &'r ActionsHandler<'octo>,
        owner: String,
        repo: String,
        name: String,
        runner_group_id: RunnerGroupId,
        labels: Vec<String>,
    ) -> Self {
        Self {
            handler,
            scope: RunnerScope::Repo { owner, repo },
            name,
            runner_group_id,
            labels,
            work_folder: None,
        }
    }

    /// The working directory to be used for job execution, relative to the runner install directory.
    pub fn work_folder(mut self, work_folder: impl Into<String>) -> Self {
        self.work_folder = Some(work_folder.into());
        self
    }

    /// Sends the actual request.
    pub async fn send(self) -> crate::Result<crate::models::actions::SelfHostedRunnerJitConfig> {
        let route = match &self.scope {
            RunnerScope::Org(org) => format!("/orgs/{org}/actions/runners/generate-jitconfig"),
            RunnerScope::Repo { owner, repo } => {
                format!("/repos/{owner}/{repo}/actions/runners/generate-jitconfig")
            }
        };

        self.handler.crab.post(route, Some(&self)).await
    }
}

impl<'octo> ActionsHandler<'octo> {
    /// Lists runner applications that are supported by GitHub Actions for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-runner-applications-for-an-organization)
    pub async fn list_org_runner_downloads(
        &self,
        org: impl AsRef<str>,
    ) -> crate::Result<Vec<crate::models::actions::RunnerApplicationDownload>> {
        let route = format!("/orgs/{org}/actions/runners/downloads", org = org.as_ref());
        self.crab.get(route, None::<&()>).await
    }

    /// Lists runner applications that are supported by GitHub Actions for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-runner-applications-for-a-repository)
    pub async fn list_repo_runner_downloads(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
    ) -> crate::Result<Vec<crate::models::actions::RunnerApplicationDownload>> {
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/downloads",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Lists labels for a self-hosted runner for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-labels-for-a-self-hosted-runner-for-an-organization)
    pub async fn list_org_runner_labels(
        &self,
        org: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/orgs/{org}/actions/runners/{runner_id}/labels",
            org = org.as_ref(),
            runner_id = runner_id,
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Adds custom labels to a self-hosted runner for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#add-custom-labels-to-a-self-hosted-runner-for-an-organization)
    pub async fn add_org_runner_labels(
        &self,
        org: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        labels: &[impl AsRef<str>],
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        #[derive(Serialize)]
        struct Body<'a> {
            labels: Vec<&'a str>,
        }
        let route = format!(
            "/orgs/{org}/actions/runners/{runner_id}/labels",
            org = org.as_ref(),
            runner_id = runner_id,
        );
        let body = Body {
            labels: labels.iter().map(AsRef::as_ref).collect(),
        };
        self.crab.post(route, Some(&body)).await
    }

    /// Sets custom labels for a self-hosted runner for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#set-custom-labels-for-a-self-hosted-runner-for-an-organization)
    pub async fn set_org_runner_labels(
        &self,
        org: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        labels: &[impl AsRef<str>],
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        #[derive(Serialize)]
        struct Body<'a> {
            labels: Vec<&'a str>,
        }
        let route = format!(
            "/orgs/{org}/actions/runners/{runner_id}/labels",
            org = org.as_ref(),
            runner_id = runner_id,
        );
        let body = Body {
            labels: labels.iter().map(AsRef::as_ref).collect(),
        };
        self.crab.put(route, Some(&body)).await
    }

    /// Removes all custom labels from a self-hosted runner for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization)
    pub async fn remove_all_org_runner_labels(
        &self,
        org: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/orgs/{org}/actions/runners/{runner_id}/labels",
            org = org.as_ref(),
            runner_id = runner_id,
        );
        self.crab.delete(route, None::<&()>).await
    }

    /// Removes a custom label from a self-hosted runner for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization)
    pub async fn remove_org_runner_label(
        &self,
        org: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        name: impl AsRef<str>,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/orgs/{org}/actions/runners/{runner_id}/labels/{name}",
            org = org.as_ref(),
            runner_id = runner_id,
            name = name.as_ref(),
        );
        self.crab.delete(route, None::<&()>).await
    }

    /// Lists labels for a self-hosted runner for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-labels-for-a-self-hosted-runner-for-a-repository)
    pub async fn list_repo_runner_labels(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            runner_id = runner_id,
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Adds custom labels to a self-hosted runner for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#add-custom-labels-to-a-self-hosted-runner-for-a-repository)
    pub async fn add_repo_runner_labels(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        labels: &[impl AsRef<str>],
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        #[derive(Serialize)]
        struct Body<'a> {
            labels: Vec<&'a str>,
        }
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            runner_id = runner_id,
        );
        let body = Body {
            labels: labels.iter().map(AsRef::as_ref).collect(),
        };
        self.crab.post(route, Some(&body)).await
    }

    /// Sets custom labels for a self-hosted runner for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#set-custom-labels-for-a-self-hosted-runner-for-a-repository)
    pub async fn set_repo_runner_labels(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        labels: &[impl AsRef<str>],
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        #[derive(Serialize)]
        struct Body<'a> {
            labels: Vec<&'a str>,
        }
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            runner_id = runner_id,
        );
        let body = Body {
            labels: labels.iter().map(AsRef::as_ref).collect(),
        };
        self.crab.put(route, Some(&body)).await
    }

    /// Removes all custom labels from a self-hosted runner for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository)
    pub async fn remove_all_repo_runner_labels(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            runner_id = runner_id,
        );
        self.crab.delete(route, None::<&()>).await
    }

    /// Removes a custom label from a self-hosted runner for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository)
    pub async fn remove_repo_runner_label(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        runner_id: crate::models::RunnerId,
        name: impl AsRef<str>,
    ) -> crate::Result<crate::models::actions::SelfHostedRunnerLabelsList> {
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            runner_id = runner_id,
            name = name.as_ref(),
        );
        self.crab.delete(route, None::<&()>).await
    }

    /// Get runner version end-of-life schedule for an organization.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#get-runner-version-end-of-life-schedule-for-an-organization)
    pub async fn get_org_runner_deprecation(
        &self,
        org: impl AsRef<str>,
        version: impl AsRef<str>,
    ) -> crate::Result<crate::models::actions::RunnerVersionDeprecation> {
        let route = format!(
            "/orgs/{org}/actions/runners/deprecations/{version}",
            org = org.as_ref(),
            version = version.as_ref(),
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Get runner version end-of-life schedule for a repository.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#get-runner-version-end-of-life-schedule-for-a-repository)
    pub async fn get_repo_runner_deprecation(
        &self,
        owner: impl AsRef<str>,
        repo: impl AsRef<str>,
        version: impl AsRef<str>,
    ) -> crate::Result<crate::models::actions::RunnerVersionDeprecation> {
        let route = format!(
            "/repos/{owner}/{repo}/actions/runners/deprecations/{version}",
            owner = owner.as_ref(),
            repo = repo.as_ref(),
            version = version.as_ref(),
        );
        self.crab.get(route, None::<&()>).await
    }
}