Skip to content
Sign up

flagon-io/g1t

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