Skip to content
Sign up

flagon-io/g1t

public
0
1,492 linesCodeBlameRaw
1//! The actions service: GitHub Actions workflows, run on g1t as they are.
2//!
3//! A repository's `.g1t/workflows/*.yml`, in GitHub's format, are read
4//! from the commit an
5//! event is about (the default branch for issues, schedules and manual
6//! runs). Each workflow an event starts becomes a run; each job of the run
7//! (one per matrix combination) runs in a sandbox once the jobs it needs
8//! have finished. Jobs report their steps and logs back as they go, and a
9//! run on a pull request's head is a status on that pull request.
10//!
11//! Secrets and variables belong to a repository or to its workspace; a
12//! repository's override its workspace's of the same name. Secret values
13//! are sealed at rest and never returned.
14//!
15//! Mirrors `packages/contracts/src/actions.ts`.
16
17use serde::{Deserialize, Serialize};
18use serde_json::Value;
19
20use crate::repos::RepoPath;
21use crate::{User, Viewer};
22
23/// A note on something in a workflow that runs differently on g1t.
24#[derive(Clone, Debug, Serialize, Deserialize)]
25#[serde(rename_all = "camelCase")]
26pub struct WorkflowNote {
27 /// `info`, `warning` or `unsupported`.
28 pub severity: String,
29 pub job: Option<String>,
30 pub message: String,
31}
32
33#[derive(Clone, Debug, Serialize, Deserialize)]
34#[serde(rename_all = "camelCase")]
35pub struct Workflow {
36 pub id: String,
37 /// `.g1t/workflows/ci.yml`.
38 pub path: String,
39 pub name: String,
40 /// The events that start it, such as `push` and `pull_request`.
41 pub events: Vec<String>,
42 /// `active`, or `disabled` when a member turned it off.
43 pub state: String,
44 /// Why the file cannot be used, if it cannot.
45 pub error: Option<String>,
46 pub notes: Vec<WorkflowNote>,
47 /// `on.workflow_dispatch.inputs` as written, when it can be run by hand.
48 pub dispatch: Option<Value>,
49 pub last_run: Option<WorkflowRun>,
50 /// For a managed workflow (`managed/<name>.yml`): what installed it.
51 #[serde(default)]
52 pub managed_by: Option<ManagedBy>,
53}
54
55/// What installed a managed workflow in a repository.
56#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
57#[serde(rename_all = "camelCase")]
58pub struct ManagedBy {
59 /// `g1t` for one g1t's services installed (such as a project's deploy
60 /// workflow), or the workspace's name for one its owners added.
61 pub origin: String,
62 /// The workspace's: `required` or `default`. Empty for g1t's.
63 #[serde(default)]
64 pub mode: String,
65 /// The workspace's: the file it was copied from, as
66 /// `owner/repo/path@ref`.
67 #[serde(default)]
68 pub source: Option<String>,
69}
70
71#[derive(Clone, Debug, Serialize, Deserialize)]
72#[serde(rename_all = "camelCase")]
73pub struct WorkflowRun {
74 pub id: String,
75 pub workflow_id: String,
76 pub path: String,
77 /// The workflow's name.
78 pub name: String,
79 /// `run-name`, or what started it: a commit's subject, a pull request's title.
80 pub title: String,
81 /// Counts the workflow's runs: 1, 2, 3…
82 pub number: u64,
83 pub attempt: u64,
84 /// The GitHub event: `push`, `pull_request`, `schedule`…
85 pub event: String,
86 #[serde(rename = "ref")]
87 pub git_ref: String,
88 pub sha: String,
89 /// The pull request it ran for, if any.
90 pub pull: Option<u32>,
91 /// `queued`, `in_progress` or `completed`.
92 pub status: String,
93 /// When completed: `success`, `failure`, `cancelled` or `skipped`.
94 pub conclusion: Option<String>,
95 /// Why it could not start, such as a workflow file that does not read.
96 pub error: Option<String>,
97 /// Username of whoever caused it.
98 pub actor: Option<String>,
99 pub created_at: String,
100 pub started_at: Option<String>,
101 pub finished_at: Option<String>,
102}
103
104#[derive(Clone, Debug, Default, Serialize, Deserialize)]
105#[serde(rename_all = "camelCase")]
106pub struct StepState {
107 /// From 1.
108 pub number: u32,
109 pub name: String,
110 /// `queued`, `in_progress` or `completed`.
111 pub status: String,
112 /// `success`, `failure`, `cancelled` or `skipped`.
113 pub conclusion: Option<String>,
114 pub started_at: Option<String>,
115 pub finished_at: Option<String>,
116}
117
118/// A message a step left with `::error::`, `::warning::` or `::notice::`.
119#[derive(Clone, Debug, Default, Serialize, Deserialize)]
120#[serde(rename_all = "camelCase")]
121pub struct Annotation {
122 /// `error`, `warning` or `notice`.
123 pub level: String,
124 pub message: String,
125 pub title: Option<String>,
126 pub file: Option<String>,
127 pub line: Option<u32>,
128}
129
130#[derive(Clone, Debug, Serialize, Deserialize)]
131#[serde(rename_all = "camelCase")]
132pub struct Job {
133 pub id: String,
134 pub run_id: String,
135 /// Its key under `jobs:`.
136 pub key: String,
137 /// With its matrix combination: `test (ubuntu-latest, 20)`.
138 pub name: String,
139 pub needs: Vec<String>,
140 /// `queued`, `waiting` (for the jobs it needs), `in_progress` or `completed`.
141 pub status: String,
142 pub conclusion: Option<String>,
143 pub steps: Vec<StepState>,
144 pub annotations: Vec<Annotation>,
145 /// Why it did not run, what stopped it, or what it waits for.
146 pub reason: Option<String>,
147 pub started_at: Option<String>,
148 pub finished_at: Option<String>,
149 /// The environment it names, once its needs are done (an expression
150 /// read by then). A job held by the environment's protection rules is
151 /// `pending` until they let it through.
152 #[serde(default)]
153 pub environment: Option<String>,
154 /// Its `runs-on` names self-hosted runners (see `runners`).
155 #[serde(default)]
156 pub self_hosted: bool,
157 /// The self-hosted runner that took it, by name.
158 #[serde(default)]
159 pub runner: Option<String>,
160 /// It was cancelled and is running its `if: always()` and `cancelled()`
161 /// steps and its post steps before it ends.
162 #[serde(default)]
163 pub cancelling: bool,
164 /// Where its deployment is (`environment.url`), for a job that deploys
165 /// and says; the current attempt's only.
166 #[serde(default, skip_serializing_if = "Option::is_none")]
167 pub environment_url: Option<String>,
168 /// For a job that calls a reusable workflow: that workflow's file. Its
169 /// jobs' keys start with this job's key and a `/`.
170 #[serde(default, skip_serializing_if = "Option::is_none")]
171 pub uses: Option<String>,
172}
173
174#[derive(Clone, Debug, Serialize, Deserialize)]
175#[serde(rename_all = "camelCase")]
176pub struct RunDetail {
177 pub run: WorkflowRun,
178 pub jobs: Vec<Job>,
179 /// The workflow's notes, as of the run's commit.
180 pub notes: Vec<WorkflowNote>,
181 /// For a run of a pull request from outside: whether it waits for, or
182 /// had, someone's approval (`status` is `action_required` while it waits).
183 #[serde(default)]
184 pub approval: Option<RunApproval>,
185 /// The environments whose protection rules hold its jobs, this attempt.
186 #[serde(default)]
187 pub pending_deployments: Vec<PendingDeployment>,
188 /// Every attempt of the run, oldest first, the one shown included.
189 /// `run.attempt` says which one `jobs` belong to.
190 #[serde(default)]
191 pub attempts: Vec<RunAttempt>,
192}
193
194/// One attempt of a run: the first, or a re-run.
195#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
196#[serde(rename_all = "camelCase")]
197pub struct RunAttempt {
198 /// From 1.
199 pub attempt: u64,
200 /// `queued`, `in_progress` or `completed`; earlier attempts are completed.
201 pub status: String,
202 pub conclusion: Option<String>,
203 /// Who started it: whoever caused the run for the first, whoever re-ran
204 /// it for the rest.
205 pub actor: Option<String>,
206 /// It ran with debug logging (`RUNNER_DEBUG=1`).
207 pub debug: bool,
208 pub started_at: Option<String>,
209 pub finished_at: Option<String>,
210}
211
212/// One job's summary: what its steps wrote to `$GITHUB_STEP_SUMMARY`, in
213/// Markdown, masked.
214#[derive(Clone, Debug, Serialize, Deserialize)]
215#[serde(rename_all = "camelCase")]
216pub struct JobSummary {
217 /// The job's id, as `RunDetail.jobs` gives it for the attempt.
218 pub job_id: String,
219 pub name: String,
220 pub steps: Vec<StepSummary>,
221}
222
223#[derive(Clone, Debug, Serialize, Deserialize)]
224#[serde(rename_all = "camelCase")]
225pub struct StepSummary {
226 /// The step, from 1 (post steps follow the job's own).
227 pub step: u32,
228 pub markdown: String,
229}
230
231/// A job's whole log, for downloading: its steps, to split the text by.
232#[derive(Clone, Debug, Serialize, Deserialize)]
233#[serde(rename_all = "camelCase")]
234pub struct JobLogText {
235 pub job_id: String,
236 pub name: String,
237 pub steps: Vec<StepState>,
238 pub chunks: Vec<LogChunk>,
239 /// Whether the job has finished.
240 pub done: bool,
241 /// Its log was left out: the run's logs reached `MAX_RUN_LOG_BYTES`.
242 #[serde(default)]
243 pub omitted: bool,
244}
245
246/// A run that needed approval before it started.
247#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
248#[serde(rename_all = "camelCase")]
249pub struct RunApproval {
250 /// `required` while it waits, then `approved`.
251 pub state: String,
252 /// Why it waits, in words.
253 pub reason: String,
254 /// Who approved it.
255 pub approved_by: Option<String>,
256}
257
258/// One person or team who may approve a job's deployment to an
259/// environment.
260#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
261pub struct EnvironmentReviewer {
262 /// `user` or `team`.
263 #[serde(rename = "type")]
264 pub kind: String,
265 /// A username, or a team's slug in the repository's workspace.
266 pub name: String,
267}
268
269/// A branch or tag pattern an environment lets deploy.
270#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
271pub struct BranchPattern {
272 /// fnmatch-style, as branch filters are: `main`, `release/*`, `v*`.
273 pub name: String,
274 /// `branch` or `tag`.
275 #[serde(rename = "type", default = "branch_kind")]
276 pub kind: String,
277}
278
279fn branch_kind() -> String {
280 "branch".to_owned()
281}
282
283/// The most reviewers an environment may have, as on GitHub.
284pub const MAX_ENVIRONMENT_REVIEWERS: usize = 6;
285/// The longest wait timer, in minutes: 30 days.
286pub const MAX_WAIT_MINUTES: u32 = 43_200;
287
288/// An environment and its protection rules. Jobs that name it with
289/// `environment:` wait until the rules let them through; only then does the
290/// job get the environment's secrets.
291#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
292#[serde(rename_all = "camelCase")]
293pub struct Environment {
294 /// Lowercase.
295 pub name: String,
296 /// Who may approve its jobs; none means no review is needed.
297 pub reviewers: Vec<EnvironmentReviewer>,
298 /// Whoever started a run may not approve its jobs, even as a reviewer.
299 pub prevent_self_review: bool,
300 /// Minutes each job waits before it may start.
301 pub wait_minutes: u32,
302 /// Which refs may deploy: `all`, `protected` (branches the rules
303 /// protect, the default branch included) or `selected` (`branch_patterns`).
304 pub branch_policy: String,
305 pub branch_patterns: Vec<BranchPattern>,
306 /// Admins may approve without being reviewers, which also skips the wait.
307 pub admins_bypass: bool,
308 /// Whether it has rules saved; false for one only named by a workflow,
309 /// a secret or a deployment.
310 pub protected: bool,
311 pub updated_at: Option<String>,
312 pub updated_by: Option<String>,
313}
314
315/// An environment holding a run's jobs, and where its rules stand.
316#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
317#[serde(rename_all = "camelCase")]
318pub struct PendingDeployment {
319 pub environment: String,
320 /// `waiting`, `approved` or `rejected`.
321 pub state: String,
322 /// Whether a reviewer must approve it before its jobs start.
323 pub needs_review: bool,
324 /// When its wait timer lets its jobs start, if it has one.
325 pub wait_until: Option<String>,
326 pub reviewers: Vec<EnvironmentReviewer>,
327 /// The jobs it holds, by name.
328 pub jobs: Vec<String>,
329 /// Whether the viewer may approve or reject it now.
330 #[serde(default)]
331 pub can_review: bool,
332 pub reviewed_by: Option<String>,
333 pub comment: Option<String>,
334 pub reviewed_at: Option<String>,
335}
336
337/// A repository's choices for its workflows.
338#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
339#[serde(rename_all = "camelCase")]
340pub struct ActionsSettings {
341 /// What a workflow without `permissions:` gets: `read` (contents and
342 /// packages read) or `write` (every permission). Unchosen, a repository
343 /// made before restricted tokens keeps `write`; a newer one takes its
344 /// workspace's default. Never more than the workspace's maximum.
345 pub default_permissions: String,
346 /// Whether the repository chose it, rather than taking it as above.
347 #[serde(default)]
348 pub default_chosen: bool,
349 /// The most the workspace lets a repository's default be.
350 #[serde(default = "write")]
351 pub max_permissions: String,
352 /// Which pull requests' runs wait for approval: `first_time_contributors`,
353 /// `outside_contributors` (the default) or `all_external_contributors`.
354 pub approval_policy: String,
355 /// Whether a job's token may open pull requests and approve them. Off
356 /// unless the repository turns it on, and only where the workspace
357 /// allows it.
358 #[serde(default)]
359 pub can_approve_pull_requests: bool,
360 /// Whether the workspace lets its repositories turn that on.
361 #[serde(default)]
362 pub workspace_allows_pull_requests: bool,
363 /// Who may use this repository's actions and reusable workflows from
364 /// their workflows, when it is private: `none` (only itself, the
365 /// default) or `organization` (private repositories of its workspace).
366 /// A public repository's are anyone's. See [`ACCESS_LEVELS`].
367 #[serde(default = "no_access")]
368 pub access_level: String,
369}
370
371fn no_access() -> String {
372 "none".to_owned()
373}
374
375/// The values of `access_level`. `user` is read as `organization`: a
376/// personal account's repositories are its own workspace's.
377pub const ACCESS_LEVELS: [&str; 2] = ["none", "organization"];
378
379/// `access_level` as given, as one of [`ACCESS_LEVELS`]; None when it is
380/// not one.
381pub fn access_level(given: &str) -> Option<&'static str> {
382 match given.trim().to_ascii_lowercase().as_str() {
383 "none" | "" => Some("none"),
384 "organization" | "user" | "workspace" => Some("organization"),
385 _ => None,
386 }
387}
388
389fn write() -> String {
390 "write".to_owned()
391}
392
393/// A workspace's policy for its repositories' tokens.
394#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
395#[serde(rename_all = "camelCase")]
396pub struct WorkspaceActionsSettings {
397 /// What a repository made from now on gets by default: `read` (the
398 /// default) or `write`.
399 pub default_permissions: String,
400 /// The most any repository's default may be: `write` (the default) or
401 /// `read`, which holds every repository to read-only.
402 pub max_permissions: String,
403 /// Whether its repositories may let jobs open and approve pull
404 /// requests. Off by default.
405 pub can_approve_pull_requests: bool,
406}
407
408/// `workspace_actions_settings`: members only. Returns
409/// `Outcome<WorkspaceActionsSettings>`.
410#[derive(Debug, Serialize, Deserialize)]
411pub struct WorkspaceActionsSettingsArgs {
412 pub viewer: Viewer,
413 pub workspace: String,
414}
415
416/// `set_workspace_actions_settings`: owners only. Fields left out stay as
417/// they are. Returns `Outcome<WorkspaceActionsSettings>`.
418#[derive(Debug, Serialize, Deserialize)]
419#[serde(rename_all = "camelCase")]
420pub struct SetWorkspaceActionsSettingsArgs {
421 pub actor: User,
422 pub workspace: String,
423 #[serde(default)]
424 pub default_permissions: Option<String>,
425 #[serde(default)]
426 pub max_permissions: Option<String>,
427 #[serde(default)]
428 pub can_approve_pull_requests: Option<bool>,
429}
430
431/// The approval policies, least strict first.
432pub const APPROVAL_POLICIES: [&str; 3] = ["first_time_contributors", "outside_contributors", "all_external_contributors"];
433
434/// `actions_settings`. Returns `Outcome<ActionsSettings>`; anyone who can
435/// read the repository may see them.
436#[derive(Debug, Serialize, Deserialize)]
437pub struct ActionsSettingsArgs {
438 pub viewer: Viewer,
439 pub repo: RepoPath,
440}
441
442/// `set_actions_settings`: Admins only. Fields left out stay as they are.
443/// Returns `Outcome<ActionsSettings>`.
444#[derive(Debug, Serialize, Deserialize)]
445#[serde(rename_all = "camelCase")]
446pub struct SetActionsSettingsArgs {
447 pub actor: User,
448 pub repo: RepoPath,
449 /// `read` or `write`; `inherit` goes back to the workspace's (or, for a
450 /// repository made before restricted tokens, `write`).
451 #[serde(default)]
452 pub default_permissions: Option<String>,
453 #[serde(default)]
454 pub approval_policy: Option<String>,
455 #[serde(default)]
456 pub can_approve_pull_requests: Option<bool>,
457 /// `none`, or `organization` (`user` reads the same). See
458 /// [`ActionsSettings::access_level`].
459 #[serde(default)]
460 pub access_level: Option<String>,
461}
462
463/// `environments`: every environment a repository's workflows, secrets,
464/// deployments or rules name, with its rules. `environment`: one, by
465/// `name`. Returns `Outcome<Vec<Environment>>` and `Outcome<Environment>`.
466#[derive(Debug, Serialize, Deserialize)]
467pub struct EnvironmentsArgs {
468 pub viewer: Viewer,
469 pub repo: RepoPath,
470 #[serde(default)]
471 pub name: Option<String>,
472}
473
474/// `set_environment`: create an environment's rules or change them. Fields
475/// left out stay as they are (none, for a new one). Admins only. Returns
476/// `Outcome<Environment>`.
477#[derive(Debug, Serialize, Deserialize)]
478#[serde(rename_all = "camelCase")]
479pub struct SetEnvironmentArgs {
480 pub actor: User,
481 pub repo: RepoPath,
482 pub name: String,
483 #[serde(default)]
484 pub reviewers: Option<Vec<EnvironmentReviewer>>,
485 #[serde(default)]
486 pub prevent_self_review: Option<bool>,
487 #[serde(default)]
488 pub wait_minutes: Option<u32>,
489 #[serde(default)]
490 pub branch_policy: Option<String>,
491 #[serde(default)]
492 pub branch_patterns: Option<Vec<BranchPattern>>,
493 #[serde(default)]
494 pub admins_bypass: Option<bool>,
495}
496
497/// `delete_environment`: its rules go; jobs naming it run without them.
498/// Its secrets' rows stay. Admins only. Returns `Outcome<bool>`.
499#[derive(Debug, Serialize, Deserialize)]
500pub struct DeleteEnvironmentArgs {
501 pub actor: User,
502 pub repo: RepoPath,
503 pub name: String,
504}
505
506/// `pending_deployments`: the environments holding a run's jobs. Returns
507/// `Outcome<Vec<PendingDeployment>>`.
508#[derive(Debug, Serialize, Deserialize)]
509pub struct PendingDeploymentsArgs {
510 pub viewer: Viewer,
511 pub repo: RepoPath,
512 pub id: String,
513}
514
515/// `review_deployments`: approve or reject a run's jobs for `environments`
516/// (every one waiting, if empty). Returns `Outcome<Vec<PendingDeployment>>`.
517#[derive(Debug, Serialize, Deserialize)]
518pub struct ReviewDeploymentsArgs {
519 pub actor: User,
520 pub repo: RepoPath,
521 pub id: String,
522 #[serde(default)]
523 pub environments: Vec<String>,
524 /// `approved` or `rejected`.
525 pub state: String,
526 #[serde(default)]
527 pub comment: Option<String>,
528}
529
530/// `repository_dispatch`: start the default branch's workflows that run
531/// `on: repository_dispatch` for `event_type`. Needs the Write role (a
532/// token's `code:write`). Returns `Outcome<u32>`: how many started.
533#[derive(Debug, Serialize, Deserialize)]
534#[serde(rename_all = "camelCase")]
535pub struct RepositoryDispatchArgs {
536 pub actor: User,
537 pub repo: RepoPath,
538 pub event_type: String,
539 #[serde(default)]
540 pub client_payload: Value,
541}
542
543#[derive(Clone, Debug, Serialize, Deserialize)]
544#[serde(rename_all = "camelCase")]
545pub struct LogChunk {
546 pub seq: u64,
547 /// The step it belongs to, from 1; 0 for the job's setup.
548 pub step: u32,
549 pub text: String,
550}
551
552#[derive(Clone, Debug, Serialize, Deserialize)]
553#[serde(rename_all = "camelCase")]
554pub struct JobLog {
555 pub chunks: Vec<LogChunk>,
556 /// Whether the job has finished, so no more will come.
557 pub done: bool,
558}
559
560/// Who may read a secret or variable: workflows (`secrets.*` and `vars.*`
561/// in GitHub Actions) and deployments (a deploy build's environment and the
562/// running app's bindings). Agents, checks and the merge queue read none.
563pub const CONSUMERS: [&str; 2] = ["workflows", "deployments"];
564
565/// One row of a repository's or workspace's secrets and variables, as
566/// Vercel lists environment variables: a key, its type, the environments
567/// it applies to and who reads it. A key may have one row per environment.
568/// Secrets' values are never returned.
569#[derive(Clone, Debug, Serialize, Deserialize)]
570#[serde(rename_all = "camelCase")]
571pub struct Setting {
572 #[serde(default)]
573 pub id: String,
574 pub name: String,
575 /// `secret`, or `variable` (shown as Config).
576 #[serde(default)]
577 pub kind: String,
578 /// A variable's value; secrets' are never returned.
579 pub value: Option<String>,
580 /// `project` (a repository's, which belong to its project) or
581 /// `workspace`.
582 pub scope: String,
583 pub updated_at: String,
584 /// `workflows` and/or `deployments`.
585 #[serde(default)]
586 pub available_to: Vec<String>,
587 /// The environments it applies to; empty is every environment.
588 #[serde(default)]
589 pub environments: Vec<String>,
590 /// A workspace's row: the projects it reaches, by slug; empty is every
591 /// project.
592 #[serde(default)]
593 pub projects: Vec<String>,
594 #[serde(default)]
595 pub note: Option<String>,
596 #[serde(default)]
597 pub updated_by: Option<String>,
598}
599
600// --- Methods ---------------------------------------------------------------
601
602/// `workflows`. Returns `Outcome<Vec<Workflow>>`.
603#[derive(Debug, Serialize, Deserialize)]
604pub struct WorkflowsArgs {
605 pub repo: RepoPath,
606 pub viewer: Viewer,
607}
608
609/// `runs`: newest first. Returns `Outcome<Vec<WorkflowRun>>`.
610#[derive(Debug, Serialize, Deserialize)]
611pub struct RunsArgs {
612 pub repo: RepoPath,
613 pub viewer: Viewer,
614 /// A workflow's id or file name.
615 #[serde(default)]
616 pub workflow: Option<String>,
617 #[serde(default)]
618 pub branch: Option<String>,
619 #[serde(default)]
620 pub event: Option<String>,
621 /// The pull request's number.
622 #[serde(default)]
623 pub pull: Option<u32>,
624 #[serde(default)]
625 pub sha: Option<String>,
626 #[serde(default)]
627 pub limit: Option<u32>,
628}
629
630/// `run`. Returns `Outcome<RunDetail>`.
631#[derive(Debug, Serialize, Deserialize)]
632pub struct RunArgs {
633 pub repo: RepoPath,
634 pub viewer: Viewer,
635 pub id: String,
636 /// An earlier attempt; the latest when absent.
637 #[serde(default)]
638 pub attempt: Option<u64>,
639}
640
641/// `summaries`: the job summaries of a run's attempt (the latest when
642/// `attempt` is absent), jobs in the run's order, those with none left
643/// out. Returns `Outcome<Vec<JobSummary>>`.
644#[derive(Debug, Serialize, Deserialize)]
645pub struct SummariesArgs {
646 pub repo: RepoPath,
647 pub viewer: Viewer,
648 pub id: String,
649 #[serde(default)]
650 pub attempt: Option<u64>,
651}
652
653/// `job_log_text`: one job's whole log, any attempt's (by the id the run
654/// gave the job). Returns `Outcome<JobLogText>`.
655#[derive(Debug, Serialize, Deserialize)]
656pub struct JobLogTextArgs {
657 pub repo: RepoPath,
658 pub viewer: Viewer,
659 pub job: String,
660}
661
662/// `run_logs`: every job's whole log for an attempt of a run (the latest
663/// when `attempt` is absent), until they add up to `MAX_RUN_LOG_BYTES`;
664/// jobs past it come `omitted`, with no chunks. Returns
665/// `Outcome<Vec<JobLogText>>`.
666#[derive(Debug, Serialize, Deserialize)]
667pub struct RunLogsArgs {
668 pub repo: RepoPath,
669 pub viewer: Viewer,
670 pub id: String,
671 #[serde(default)]
672 pub attempt: Option<u64>,
673}
674
675/// The most log `run_logs` returns at once, in bytes.
676pub const MAX_RUN_LOG_BYTES: usize = 24 * 1024 * 1024;
677
678/// `logs`: a job's log after `after`. Returns `Outcome<JobLog>`.
679#[derive(Debug, Serialize, Deserialize)]
680pub struct LogsArgs {
681 pub repo: RepoPath,
682 pub viewer: Viewer,
683 pub job: String,
684 #[serde(default)]
685 pub after: u64,
686}
687
688/// `dispatch`: run a workflow that has `workflow_dispatch`. Members only.
689/// Returns `Outcome<WorkflowRun>`.
690#[derive(Debug, Serialize, Deserialize)]
691pub struct DispatchArgs {
692 pub actor: User,
693 pub repo: RepoPath,
694 /// A workflow's id or file name.
695 pub workflow: String,
696 /// A branch or tag; the default branch when absent.
697 #[serde(default, rename = "ref")]
698 pub git_ref: Option<String>,
699 #[serde(default)]
700 pub inputs: serde_json::Map<String, Value>,
701}
702
703/// `cancel` and `rerun`: every job, with `failed_only` the ones that did
704/// not succeed, or with `job` that one job (by its id in the run's latest
705/// attempt); each with the jobs that need them. `debug` runs the new
706/// attempt with debug logging. Members only. Returns `Outcome<WorkflowRun>`.
707#[derive(Debug, Serialize, Deserialize)]
708pub struct RunActionArgs {
709 pub actor: User,
710 pub repo: RepoPath,
711 pub id: String,
712 #[serde(default)]
713 pub failed_only: bool,
714 #[serde(default)]
715 pub job: Option<String>,
716 #[serde(default)]
717 pub debug: bool,
718 /// `cancel`: stop running jobs outright, without their cleanup steps.
719 #[serde(default)]
720 pub force: bool,
721}
722
723/// `set_workflow_enabled`. Members only. Returns `Outcome<Workflow>`.
724#[derive(Debug, Serialize, Deserialize)]
725pub struct SetWorkflowEnabledArgs {
726 pub actor: User,
727 pub repo: RepoPath,
728 pub workflow: String,
729 pub enabled: bool,
730}
731
732/// Whose secrets or variables: a repository's, or with only `workspace`,
733/// a workspace's.
734#[derive(Clone, Debug, Serialize, Deserialize)]
735pub struct SettingsOwner {
736 #[serde(default)]
737 pub repo: Option<RepoPath>,
738 #[serde(default)]
739 pub workspace: Option<String>,
740}
741
742/// `settings`: the secrets (`kind: secret`) or variables (`kind: variable`)
743/// of a repository, with its workspace's, or of a workspace. Members only.
744/// Returns `Outcome<Vec<Setting>>`.
745#[derive(Debug, Serialize, Deserialize)]
746pub struct SettingsArgs {
747 pub actor: User,
748 #[serde(flatten)]
749 pub owner: SettingsOwner,
750 pub kind: String,
751}
752
753/// `set_setting`: add or replace one. A repository's need a member; a
754/// workspace's an owner. Returns `Outcome<Setting>`.
755#[derive(Debug, Serialize, Deserialize)]
756pub struct SetSettingArgs {
757 pub actor: User,
758 #[serde(flatten)]
759 pub owner: SettingsOwner,
760 /// `secret` or `variable`. Changing a variable's row to `secret` seals
761 /// it; a secret cannot become a variable.
762 pub kind: String,
763 pub name: String,
764 /// The row to change. Left out, the key's row for every environment, as
765 /// GitHub's API addresses a secret by name alone.
766 #[serde(default)]
767 pub id: Option<String>,
768 /// Needed for a new row; left out, an existing row keeps its value.
769 #[serde(default)]
770 pub value: Option<String>,
771 /// `workflows` and/or `deployments`; left out, unchanged (both, for a
772 /// new row).
773 // Named as callers send it: an `alias` is not honoured beside the
774 // flattened owner in the Worker's build.
775 #[serde(default, rename = "availableTo")]
776 pub available_to: Option<Vec<String>>,
777 /// The environments it applies to; empty is every one. Left out,
778 /// unchanged.
779 #[serde(default)]
780 pub environments: Option<Vec<String>>,
781 /// A workspace's row: project slugs; empty for every one.
782 #[serde(default)]
783 pub projects: Option<Vec<String>>,
784 #[serde(default)]
785 pub note: Option<String>,
786}
787
788/// `set_managed_workflow`: installs, or replaces, a managed workflow in a
789/// repository (`g1t_actions::managed`): one that runs as if it were in
790/// `.g1t/workflows/` without being committed there, under the path
791/// `managed/<name>.yml`. For g1t's own services; never reached from the API.
792/// Refused when `source` is not a workflow g1t can read. Returns `bool`.
793#[derive(Debug, Serialize, Deserialize)]
794#[serde(rename_all = "camelCase")]
795pub struct SetManagedWorkflowArgs {
796 pub repo_id: String,
797 /// Letters, digits and hyphens: the file name its path ends with.
798 pub name: String,
799 pub source: String,
800 /// What keeps it: `deployments`, or a workspace's id.
801 pub origin: String,
802}
803
804/// `set_managed_deploy`: installs, replaces or removes the deploy workflow
805/// a project's deployments run through (`g1t_actions::managed`), named
806/// `deploy-<project>`, from the project's settings. Nothing deploys (both
807/// `previews` and `production` off) removes it. For the deployments
808/// service only. Returns `bool`, whether one is installed now.
809#[derive(Debug, Serialize, Deserialize)]
810#[serde(rename_all = "camelCase")]
811pub struct SetManagedDeployArgs {
812 pub repo_id: String,
813 pub project: String,
814 pub production_branch: String,
815 #[serde(default)]
816 pub root_dir: String,
817 #[serde(default)]
818 pub build_command: String,
819 #[serde(default)]
820 pub output_dir: String,
821 pub previews: bool,
822 pub production: bool,
823}
824
825/// A workflow a workspace's owners added to its repositories
826/// (`g1t_actions::managed::Target`): it runs in each repository it targets
827/// as that repository's own, with its token and secrets, under the path
828/// `managed/<name>.yml`, from a copy of its source taken when it was saved.
829#[derive(Clone, Debug, Serialize, Deserialize)]
830#[serde(rename_all = "camelCase")]
831pub struct WorkspaceManagedWorkflow {
832 /// Lowercase letters, digits and hyphens: its path is
833 /// `managed/<name>.yml`.
834 pub name: String,
835 pub path: String,
836 /// Its `name:`, as repositories list it; a repository's workflow of
837 /// this name takes a default one's place.
838 pub workflow_name: String,
839 /// Where it was copied from: `owner/repo/path@ref`, a repository of the
840 /// same workspace.
841 pub source: String,
842 /// The commit it was copied at.
843 pub source_sha: Option<String>,
844 /// Whether the source repository is private, so the workflow runs in
845 /// private repositories only.
846 pub source_private: bool,
847 /// `required` or `default`.
848 pub mode: String,
849 /// Names and patterns of the repositories it runs in; empty is every one.
850 pub repositories: Vec<String>,
851 /// `all`, `public` or `private`.
852 pub visibility: String,
853 /// The copy that runs.
854 pub content: String,
855 pub created_at: String,
856 pub updated_at: String,
857 pub updated_by: String,
858}
859
860/// `workspace_managed_workflows`: owners only. Returns
861/// `Outcome<Vec<WorkspaceManagedWorkflow>>`.
862#[derive(Debug, Serialize, Deserialize)]
863pub struct WorkspaceManagedWorkflowsArgs {
864 pub viewer: Viewer,
865 pub workspace: String,
866}
867
868/// `set_workspace_managed_workflow`: owners only. Adds one (`create`, which
869/// needs `source` and `mode`) or changes one; fields left out stay as they
870/// are. The source is copied again when it is given or `refresh` is set.
871/// Refused when the source is not a workflow file in a repository of the
872/// workspace, or is private while the workflow could run in a public
873/// repository. Returns `Outcome<WorkspaceManagedWorkflow>`.
874#[derive(Debug, Serialize, Deserialize)]
875#[serde(rename_all = "camelCase")]
876pub struct SetWorkspaceManagedWorkflowArgs {
877 pub actor: User,
878 pub workspace: String,
879 pub name: String,
880 #[serde(default)]
881 pub create: bool,
882 /// `owner/repo/.g1t/workflows/file.yml@ref`.
883 #[serde(default)]
884 pub source: Option<String>,
885 #[serde(default)]
886 pub mode: Option<String>,
887 #[serde(default)]
888 pub repositories: Option<Vec<String>>,
889 #[serde(default)]
890 pub visibility: Option<String>,
891 #[serde(default)]
892 pub refresh: bool,
893}
894
895/// `remove_workspace_managed_workflow`: owners only. Its runs stay.
896/// Returns `Outcome<bool>`, whether there was one.
897#[derive(Debug, Serialize, Deserialize)]
898pub struct RemoveWorkspaceManagedWorkflowArgs {
899 pub actor: User,
900 pub workspace: String,
901 pub name: String,
902}
903
904/// `remove_managed_workflow`: takes a managed workflow out of a repository.
905/// Its runs stay. Returns `bool`, whether there was one.
906#[derive(Debug, Serialize, Deserialize)]
907#[serde(rename_all = "camelCase")]
908pub struct RemoveManagedWorkflowArgs {
909 pub repo_id: String,
910 pub name: String,
911}
912
913/// `resolve_settings`: the secrets and variables one reader gets, for the
914/// services that hand them out (the deployments service). Returns
915/// `ResolvedSettings`.
916#[derive(Debug, Serialize, Deserialize)]
917#[serde(rename_all = "camelCase")]
918pub struct ResolveSettingsArgs {
919 pub repo_id: String,
920 pub repo: RepoPath,
921 /// The project being read for; its repository's primary project if left
922 /// out.
923 #[serde(default)]
924 pub project_id: Option<String>,
925 #[serde(default)]
926 pub project_slug: Option<String>,
927 /// `workflows` or `deployments`.
928 pub consumer: String,
929 /// The environment being read for, such as `production` or `preview`.
930 #[serde(default)]
931 pub environment: Option<String>,
932 /// Whether the run is trusted; an untrusted one gets no secrets.
933 pub trusted: bool,
934}
935
936#[derive(Debug, Default, Serialize, Deserialize)]
937pub struct ResolvedSettings {
938 pub secrets: serde_json::Map<String, serde_json::Value>,
939 pub variables: serde_json::Map<String, serde_json::Value>,
940}
941
942/// `delete_setting`. Returns `Outcome<bool>`.
943#[derive(Debug, Serialize, Deserialize)]
944pub struct DeleteSettingArgs {
945 pub actor: User,
946 #[serde(flatten)]
947 pub owner: SettingsOwner,
948 pub kind: String,
949 pub name: String,
950 /// One row; left out, every row of the key.
951 #[serde(default)]
952 pub id: Option<String>,
953}
954
955/// `job_spec` and `job_report`: the sandbox running a job, with the job's
956/// own token. `report` is one of:
957/// `{"kind": "step", "number", "status", "conclusion"}`,
958/// `{"kind": "log", "step", "text"}`,
959/// `{"kind": "annotation", "level", "message", "title", "file", "line"}`,
960/// `{"kind": "done", "conclusion", "outputs", "reason"}`.
961#[derive(Debug, Serialize, Deserialize)]
962pub struct JobCallArgs {
963 pub job: String,
964 pub token: String,
965 #[serde(default)]
966 pub report: Value,
967}
968
969/// What the runner needs to start a job's sandbox.
970#[derive(Debug, Serialize, Deserialize)]
971#[serde(rename_all = "camelCase")]
972pub struct StartJobArgs {
973 pub job: String,
974 pub token: String,
975 pub repo: RepoPath,
976 /// Minutes before the job is stopped.
977 pub timeout_minutes: u32,
978 /// The workflow file the job is in (`.g1t/workflows/deploy.yml`), for
979 /// the guardrails' workflow-only domains.
980 #[serde(default)]
981 pub workflow: Option<String>,
982 /// The environment the job names with `environment:`, when it names
983 /// one plainly (not with an expression).
984 #[serde(default)]
985 pub environment: Option<String>,
986 /// Whether its run is trusted: not a pull request from a fork. Only a
987 /// trusted run's jobs reach workflow-only domains.
988 #[serde(default)]
989 pub trusted: bool,
990 /// The machine its `runs-on` asked for, by label (`instance_for`):
991 /// `g1t-2core` or `g1t-4core`; absent, the standard one.
992 #[serde(default)]
993 pub instance: Option<String>,
994}
995
996/// A size of machine g1t runs workflow jobs on, asked for by a label in
997/// `runs-on`. Each is a Cloudflare Containers instance type; it costs what
998/// that instance costs g1t, plus the margin, like any sandbox time.
999#[derive(Clone, Copy, Debug, PartialEq)]
1000pub struct InstanceType {
1001 /// The `runs-on` label, or `standard` for the default.
1002 pub label: &'static str,
1003 /// The Containers instance type.
1004 pub container: &'static str,
1005 pub vcpu: f64,
1006 pub memory_gib: f64,
1007 pub disk_gb: f64,
1008 /// What a second of it costs g1t as a multiple of the standard
1009 /// machine's, with its vCPUs as busy (Cloudflare's list prices:
1010 /// memory $0.0000025 a GiB-second, disk $0.00000007 a GB-second, vCPU
1011 /// $0.00002 a second). Used to reserve before a job starts, and to
1012 /// price a job that did not report its own CPU.
1013 pub price_scale: f64,
1014}
1015
1016/// The default: what `ubuntu-latest` and every other hosted label get.
1017pub const STANDARD_INSTANCE: InstanceType =
1018 InstanceType { label: "standard", container: "standard-1", vcpu: 0.5, memory_gib: 4.0, disk_gb: 8.0, price_scale: 1.0 };
1019
1020/// Every machine a workflow job can ask for, the default first.
1021pub const INSTANCE_TYPES: [InstanceType; 3] = [
1022 STANDARD_INSTANCE,
1023 InstanceType { label: "g1t-2core", container: "standard-3", vcpu: 2.0, memory_gib: 8.0, disk_gb: 16.0, price_scale: 2.8 },
1024 InstanceType { label: "g1t-4core", container: "standard-4", vcpu: 4.0, memory_gib: 12.0, disk_gb: 20.0, price_scale: 5.1 },
1025];
1026
1027/// The machine a job's `runs-on` labels ask for: the largest named, or the
1028/// standard one. Labels compare without regard to case.
1029pub fn instance_for(labels: &[String]) -> InstanceType {
1030 INSTANCE_TYPES
1031 .iter()
1032 .rev()
1033 .find(|instance| instance.label != STANDARD_INSTANCE.label && labels.iter().any(|label| label.trim().eq_ignore_ascii_case(instance.label)))
1034 .copied()
1035 .unwrap_or(STANDARD_INSTANCE)
1036}
1037
1038/// An instance type by its label, if it is one.
1039pub fn instance_named(label: &str) -> Option<InstanceType> {
1040 INSTANCE_TYPES.iter().find(|instance| instance.label.eq_ignore_ascii_case(label.trim())).copied()
1041}
1042
1043// ── The cache (actions/cache) ─────────────────────────────────────────────
1044//
1045// Entries are kept in R2 by the API (the ACTIONS_CACHE bucket) and listed
1046// here, by the actions service, which decides what is found, what fits and
1047// what is evicted. A sandbox reaches these through the API with its job's
1048// token: `/actions/jobs/{job}/cache` (see apps/api/src/blobs.rs).
1049
1050/// The largest one cache entry may be, compressed.
1051pub const CACHE_MAX_ENTRY_BYTES: u64 = 2 * 1024 * 1024 * 1024;
1052/// What one repository's entries may hold together. Saving past it evicts
1053/// the entries restored longest ago.
1054pub const CACHE_REPO_QUOTA_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1055/// An entry not restored for this long is deleted.
1056pub const CACHE_UNUSED_DAYS: u64 = 7;
1057/// An entry is deleted this long after it was saved, however often it is
1058/// restored (the bucket's own lifecycle rule deletes objects at 30 days).
1059pub const CACHE_MAX_AGE_DAYS: u64 = 28;
1060/// An upload is sent in parts of this size (the last may be smaller).
1061pub const CACHE_PART_BYTES: u64 = 32 * 1024 * 1024;
1062/// What R2 charges g1t to store a GB for a month, in millionths of a
1063/// dollar ($0.015): what the cache's storage is charged at, plus the margin.
1064pub const CACHE_MICROS_PER_GB_MONTH: i64 = 15_000;
1065
1066/// `cache_lookup`: the entry a job restores: its key exactly, else the
1067/// newest whose key starts with one of `restore`, in order.
1068/// Returns `Outcome<Option<CacheHit>>`.
1069#[derive(Debug, Serialize, Deserialize)]
1070pub struct CacheLookupArgs {
1071 pub job: String,
1072 pub token: String,
1073 pub key: String,
1074 #[serde(default)]
1075 pub restore: Vec<String>,
1076 /// The entry's version, a hash of its paths and compression, as the
1077 /// toolkit's client and g1t's runner both send it: only an entry of the
1078 /// same version is found. `None` from runners that send none, whose
1079 /// entries have none.
1080 #[serde(default)]
1081 pub version: Option<String>,
1082}
1083
1084#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1085pub struct CacheHit {
1086 pub key: String,
1087 pub object: String,
1088 pub size: u64,
1089 /// When it was saved, RFC 3339.
1090 #[serde(default)]
1091 pub created_at: String,
1092 /// A signed token for downloading it through the toolkit's blob
1093 /// endpoint, when the lookup came with a version.
1094 #[serde(default)]
1095 pub blob: Option<String>,
1096}
1097
1098/// `cache_reserve`: a job about to save `size` bytes under `key`. Refused
1099/// when the key is taken (`conflict`: keys are written once) or the entry
1100/// is too large. Returns `Outcome<CacheReservation>`.
1101#[derive(Debug, Serialize, Deserialize)]
1102pub struct CacheReserveArgs {
1103 pub job: String,
1104 pub token: String,
1105 pub key: String,
1106 /// Its size, when known before it is sent (the toolkit's newer client
1107 /// says only when it finishes: 0 then).
1108 pub size: u64,
1109 /// As in `CacheLookupArgs`.
1110 #[serde(default)]
1111 pub version: Option<String>,
1112}
1113
1114#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1115pub struct CacheReservation {
1116 pub id: String,
1117 /// Where the API puts it in R2.
1118 pub object: String,
1119 /// The entry's number, which the toolkit's older protocol names it by.
1120 #[serde(default)]
1121 pub number: u64,
1122 /// Its R2 upload, once one is started.
1123 #[serde(default)]
1124 pub upload: Option<String>,
1125 /// A signed token for sending its parts through the toolkit's blob
1126 /// endpoint, once its upload is started.
1127 #[serde(default)]
1128 pub blob: Option<String>,
1129}
1130
1131/// `cache_upload`: an entry a job is still uploading, by its number or by
1132/// key and version. Returns `Outcome<CacheReservation>`, with `upload` and
1133/// `blob` set once its upload has been started.
1134#[derive(Debug, Serialize, Deserialize)]
1135pub struct CacheUploadArgs {
1136 pub job: String,
1137 pub token: String,
1138 #[serde(default)]
1139 pub number: Option<u64>,
1140 #[serde(default)]
1141 pub key: Option<String>,
1142 #[serde(default)]
1143 pub version: Option<String>,
1144}
1145
1146/// `cache_commit`: the upload of `id` is complete, at `size` bytes. Returns
1147/// `Outcome<CacheCommitted>`: the objects of entries it evicted, which the
1148/// API deletes from R2.
1149#[derive(Debug, Serialize, Deserialize)]
1150pub struct CacheCommitArgs {
1151 pub job: String,
1152 pub token: String,
1153 pub id: String,
1154 pub size: u64,
1155}
1156
1157#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1158pub struct CacheCommitted {
1159 pub evicted: Vec<String>,
1160}
1161
1162/// `cache_abort`: an upload that will not finish; its reservation goes.
1163/// Returns `Outcome<bool>`.
1164#[derive(Debug, Serialize, Deserialize)]
1165pub struct CacheAbortArgs {
1166 pub job: String,
1167 pub token: String,
1168 pub id: String,
1169}
1170
1171// ── Artifacts (actions/upload-artifact) ───────────────────────────────────
1172//
1173// Kept in R2 by the API (the ACTIONS_CACHE bucket, under `a/`) and listed
1174// here, by the actions service, which decides names, sizes and how long
1175// each is kept. A sandbox reaches them with its job's token
1176// (`/actions/jobs/{job}/artifacts…`) or, through the toolkit's protocol,
1177// with its runtime token (`ACTIONS_RUNTIME_TOKEN`); people through the
1178// REST API and the run's page.
1179
1180/// The largest one artifact may be.
1181pub const ARTIFACT_MAX_BYTES: u64 = 5 * 1024 * 1024 * 1024;
1182/// What one run's artifacts may hold together.
1183pub const RUN_ARTIFACTS_MAX_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1184/// How long artifacts are kept unless a repository says otherwise.
1185pub const ARTIFACT_RETENTION_DEFAULT_DAYS: u32 = 14;
1186/// The longest a repository may keep them.
1187pub const ARTIFACT_RETENTION_MAX_DAYS: u32 = 90;
1188/// A native upload is sent in parts of this size (the last may be smaller).
1189pub const ARTIFACT_PART_BYTES: u64 = 32 * 1024 * 1024;
1190
1191/// An artifact, as the API and the site show it.
1192#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1193pub struct Artifact {
1194 pub id: u64,
1195 pub name: String,
1196 pub size: u64,
1197 /// `sha256:<hex>`, when the uploader said.
1198 pub digest: Option<String>,
1199 /// `zip`, or `tgz` for one an older runner sent.
1200 pub format: String,
1201 pub run_id: String,
1202 pub job_id: String,
1203 pub repo_id: String,
1204 /// Whether it has expired or been deleted (its bytes are gone).
1205 pub expired: bool,
1206 pub created_at: String,
1207 pub updated_at: String,
1208 pub expires_at: String,
1209 /// The run's branch and commit, for the REST shape.
1210 #[serde(default)]
1211 pub head_branch: Option<String>,
1212 #[serde(default)]
1213 pub head_sha: Option<String>,
1214}
1215
1216/// An artifact with where its bytes are, and a signed token for them.
1217#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1218pub struct ArtifactBlob {
1219 pub artifact: Artifact,
1220 pub object: String,
1221 /// For the toolkit's blob endpoint (`/actions/toolkit/blobs/{blob}`).
1222 pub blob: String,
1223}
1224
1225/// A page of artifacts, in GitHub's shape.
1226#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1227pub struct ArtifactList {
1228 pub total_count: u64,
1229 pub artifacts: Vec<Artifact>,
1230}
1231
1232/// `artifact_reserve`: a job about to upload an artifact. Refused when its
1233/// run has one of that name and `overwrite` is not set (`conflict`), or it
1234/// is too large. Returns `Outcome<ArtifactReservation>`.
1235#[derive(Debug, Default, Serialize, Deserialize)]
1236pub struct ArtifactReserveArgs {
1237 pub job: String,
1238 /// The job's token, or its runtime token.
1239 pub token: String,
1240 pub name: String,
1241 /// Its size, when known before it is sent (0 otherwise).
1242 #[serde(default)]
1243 pub size: u64,
1244 /// Days to keep it: 0 for the repository's default; at most the
1245 /// repository's setting.
1246 #[serde(default)]
1247 pub retention_days: u32,
1248 /// When to expire it, RFC 3339, as the toolkit says it (in place of
1249 /// `retention_days`).
1250 #[serde(default)]
1251 pub expires_at: Option<String>,
1252 #[serde(default)]
1253 pub overwrite: bool,
1254 /// `zip` (the default) or `tgz`.
1255 #[serde(default)]
1256 pub format: Option<String>,
1257}
1258
1259#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1260pub struct ArtifactReservation {
1261 pub id: u64,
1262 /// Where the API puts it in R2.
1263 pub object: String,
1264 /// The days it will be kept, and until when.
1265 pub retention_days: u32,
1266 pub expires_at: String,
1267}
1268
1269/// `artifact_commit`: its upload is complete, at `size` bytes. The artifact
1270/// is named by `id`, or by `name` in the job's run (the toolkit's way).
1271/// Returns `Outcome<Artifact>`.
1272#[derive(Debug, Default, Serialize, Deserialize)]
1273pub struct ArtifactCommitArgs {
1274 pub job: String,
1275 pub token: String,
1276 #[serde(default)]
1277 pub id: Option<u64>,
1278 #[serde(default)]
1279 pub name: Option<String>,
1280 pub size: u64,
1281 #[serde(default)]
1282 pub digest: Option<String>,
1283}
1284
1285/// `job_artifacts`: a running job listing the artifacts of its own run, or
1286/// of another run of its repository (`run_id`), narrowed by `name` or
1287/// `id`: `Outcome<Vec<Artifact>>`. `job_artifact` gives the one named, with
1288/// a token to download it: `Outcome<ArtifactBlob>`. `job_delete_artifact`
1289/// deletes one of its own run's: `Outcome<Artifact>`. `artifact_abort`
1290/// gives up an upload by `id`: `Outcome<bool>`.
1291#[derive(Debug, Default, Serialize, Deserialize)]
1292pub struct JobArtifactsArgs {
1293 pub job: String,
1294 pub token: String,
1295 #[serde(default)]
1296 pub run_id: Option<String>,
1297 #[serde(default)]
1298 pub name: Option<String>,
1299 #[serde(default)]
1300 pub id: Option<u64>,
1301}
1302
1303/// `artifacts`: a repository's artifacts, newest first, or one run's.
1304/// Anyone who can see the repository. Returns `Outcome<ArtifactList>`.
1305#[derive(Debug, Serialize, Deserialize)]
1306pub struct ArtifactsArgs {
1307 pub repo: RepoPath,
1308 pub viewer: Viewer,
1309 #[serde(default)]
1310 pub run: Option<String>,
1311 #[serde(default)]
1312 pub name: Option<String>,
1313 #[serde(default)]
1314 pub page: Option<u32>,
1315 #[serde(default)]
1316 pub per_page: Option<u32>,
1317}
1318
1319/// `artifact` (`Outcome<Artifact>`) and `artifact_download`
1320/// (`Outcome<ArtifactBlob>`, with a token good for a few minutes): one
1321/// artifact by `id`, or by `name` within `run`. Anyone who can see the
1322/// repository.
1323#[derive(Debug, Serialize, Deserialize)]
1324pub struct ArtifactArgs {
1325 pub repo: RepoPath,
1326 pub viewer: Viewer,
1327 #[serde(default)]
1328 pub id: Option<u64>,
1329 #[serde(default)]
1330 pub run: Option<String>,
1331 #[serde(default)]
1332 pub name: Option<String>,
1333}
1334
1335/// `delete_artifact`: needs the Write role. Returns `Outcome<Artifact>`.
1336#[derive(Debug, Serialize, Deserialize)]
1337pub struct DeleteArtifactArgs {
1338 pub actor: User,
1339 pub repo: RepoPath,
1340 pub id: u64,
1341}
1342
1343/// `artifact_retention`: anyone who can see the repository. With `days`,
1344/// sets it, which needs the Maintain role. Returns
1345/// `Outcome<ArtifactRetention>`.
1346#[derive(Debug, Serialize, Deserialize)]
1347pub struct ArtifactRetentionArgs {
1348 pub repo: RepoPath,
1349 pub viewer: Viewer,
1350 #[serde(default)]
1351 pub days: Option<u32>,
1352}
1353
1354/// GitHub's shape: the days artifacts are kept by default, and the most a
1355/// repository may choose.
1356#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1357pub struct ArtifactRetention {
1358 pub days: u32,
1359 pub maximum_allowed_days: u32,
1360}
1361
1362// ── The toolkit's protocols ───────────────────────────────────────────────
1363//
1364// Actions built on GitHub's toolkit (`@actions/cache`, `@actions/artifact`,
1365// `@actions/core`'s `getIDToken`) reach g1t with the job's runtime token,
1366// `ACTIONS_RUNTIME_TOKEN`: a JSON Web Token whose `scp` names the run and
1367// job, signed with a key derived from the job's own token, so the actions
1368// service checks it without keeping another secret. Cache and artifact
1369// operations above take it in place of the job's token.
1370
1371/// `runtime_auth`: which job a runtime token is, while it runs:
1372/// `Outcome<RuntimeJob>`. `oidc_claims` takes the same and returns
1373/// `Outcome<Value>`: the claims of the job's OIDC token, less `iss`, `aud`,
1374/// `jti` and the times, or `forbidden` when the job's `permissions` do not
1375/// give it `id-token: write`.
1376#[derive(Debug, Serialize, Deserialize)]
1377pub struct RuntimeAuthArgs {
1378 pub job: String,
1379 pub token: String,
1380}
1381
1382#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1383pub struct RuntimeJob {
1384 pub job: String,
1385 pub run: String,
1386 pub repo_id: String,
1387 pub namespace: String,
1388 /// `owner/name`.
1389 pub repository: String,
1390}
1391
1392/// What a signed blob token lets its holder do.
1393#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1394pub struct BlobGrant {
1395 /// `cache` or `artifact`.
1396 pub kind: String,
1397 /// The entry's id: a cache entry's `cache_…`, an artifact's number.
1398 pub id: String,
1399 pub object: String,
1400 /// The R2 upload it sends parts to; `None` for a download.
1401 pub upload: Option<String>,
1402 /// For a download: what to call the file, and its type.
1403 #[serde(default)]
1404 pub filename: Option<String>,
1405 #[serde(default)]
1406 pub content_type: Option<String>,
1407}
1408
1409/// `blob_sign`: a token for uploading an entry the job reserved, to the R2
1410/// upload the API started for it. Returns `Outcome<String>`.
1411#[derive(Debug, Serialize, Deserialize)]
1412pub struct BlobSignArgs {
1413 pub job: String,
1414 pub token: String,
1415 /// `cache` or `artifact`.
1416 pub kind: String,
1417 pub id: String,
1418 pub upload: String,
1419}
1420
1421/// `blob_open`: what a signed token grants, while it is good and its entry
1422/// is there: `Outcome<BlobGrant>`. `blob_part` records a part sent with an
1423/// upload token (`part`, `etag`, `size`): `Outcome<bool>`. `blob_parts`
1424/// gives the parts recorded, in order: `Outcome<Vec<BlobPart>>`, and
1425/// `blob_done` forgets them: `Outcome<bool>`.
1426#[derive(Debug, Default, Serialize, Deserialize)]
1427pub struct BlobArgs {
1428 pub blob: String,
1429 #[serde(default)]
1430 pub part: u32,
1431 #[serde(default)]
1432 pub etag: String,
1433 #[serde(default)]
1434 pub size: u64,
1435}
1436
1437#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1438pub struct BlobPart {
1439 pub part: u32,
1440 pub etag: String,
1441 pub size: u64,
1442}
1443
1444#[cfg(test)]
1445mod instance_tests {
1446 use super::*;
1447
1448 fn labels(given: &[&str]) -> Vec<String> {
1449 given.iter().map(|l| (*l).to_owned()).collect()
1450 }
1451
1452 #[test]
1453 fn runs_on_picks_the_machine() {
1454 assert_eq!(instance_for(&labels(&["ubuntu-latest"])).container, "standard-1");
1455 assert_eq!(instance_for(&labels(&[])).label, "standard");
1456 assert_eq!(instance_for(&labels(&["g1t-4core"])).container, "standard-4");
1457 assert_eq!(instance_for(&labels(&["ubuntu-latest", "G1T-2Core"])).container, "standard-3");
1458 // Both named: the larger.
1459 assert_eq!(instance_for(&labels(&["g1t-2core", "g1t-4core"])).label, "g1t-4core");
1460 assert_eq!(instance_named("g1t-4core").map(|i| i.vcpu), Some(4.0));
1461 assert_eq!(instance_named("standard"), Some(STANDARD_INSTANCE));
1462 assert_eq!(instance_named("g1t-64core"), None);
1463 }
1464
1465 #[test]
1466 fn start_args_from_older_callers_read() {
1467 let args: StartJobArgs = serde_json::from_value(serde_json::json!({
1468 "job": "job_1", "token": "t", "repo": { "namespace": "acme", "name": "web" }, "timeoutMinutes": 30
1469 }))
1470 .unwrap();
1471 assert!(args.workflow.is_none() && args.environment.is_none() && !args.trusted && args.instance.is_none());
1472 }
1473}
1474
1475#[cfg(test)]
1476mod setting_args_tests {
1477 use super::*;
1478
1479 #[test]
1480 fn who_reads_a_row_is_read_as_the_site_and_api_send_it() {
1481 let args: SetSettingArgs = serde_json::from_value(serde_json::json!({
1482 "actor": { "id": "usr_1", "username": "a" },
1483 "repo": { "namespace": "acme", "name": "web" },
1484 "kind": "secret",
1485 "name": "STRIPE_KEY",
1486 "availableTo": ["deployments"],
1487 "environments": ["production"],
1488 }))
1489 .unwrap();
1490 assert_eq!(args.available_to, Some(vec!["deployments".to_owned()]));
1491 }
1492}