Skip to content
Sign up

flagon-io/g1t

public
00

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

gitagentscloudflarerustforgemcp
1,561 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 /// A brokered secret's hosts: a job gets a stand-in for it, and g1t
599 /// puts the real value on the job's requests to these hosts as they
600 /// leave its sandbox. Empty for a secret that is not brokered, and for
601 /// config.
602 #[serde(default)]
603 pub brokered_hosts: Vec<String>,
604}
605
606/// How a brokered secret's stand-in starts. The rest is 48 random hex
607/// characters, so the whole is shaped like a token and tools take it.
608pub const STAND_IN_PREFIX: &str = "g1tsec_";
609
610/// A stand-in a running job was given for a brokered secret, as the runner
611/// Worker asks for them (`brokered_secrets`) to fill in the real value on
612/// the job's requests to `hosts`.
613#[derive(Clone, Debug, Serialize, Deserialize)]
614#[serde(rename_all = "camelCase")]
615pub struct BrokeredSecret {
616 pub stand_in: String,
617 /// The secret's key, for the job's log.
618 pub name: String,
619 pub value: String,
620 pub hosts: Vec<String>,
621}
622
623// --- Methods ---------------------------------------------------------------
624
625/// `workflows`. Returns `Outcome<Vec<Workflow>>`.
626#[derive(Debug, Serialize, Deserialize)]
627pub struct WorkflowsArgs {
628 pub repo: RepoPath,
629 pub viewer: Viewer,
630}
631
632/// `workflow`: one workflow, named by its id (`wfl_…`), its file name
633/// (`ci.yml`), its path or its name, with its file as of `ref` (the
634/// default branch when absent). Returns `Outcome<WorkflowDetail>`.
635#[derive(Debug, Serialize, Deserialize)]
636pub struct WorkflowArgs {
637 pub repo: RepoPath,
638 pub viewer: Viewer,
639 pub workflow: String,
640 #[serde(default, rename = "ref")]
641 pub git_ref: Option<String>,
642}
643
644/// A workflow with its file.
645#[derive(Clone, Debug, Serialize, Deserialize)]
646#[serde(rename_all = "camelCase")]
647pub struct WorkflowDetail {
648 #[serde(flatten)]
649 pub workflow: Workflow,
650 /// The branch or tag the file was read from.
651 #[serde(rename = "ref")]
652 pub git_ref: String,
653 /// The file, as written on `ref`.
654 pub source: String,
655}
656
657/// `runs`: newest first. Returns `Outcome<Vec<WorkflowRun>>`.
658#[derive(Debug, Serialize, Deserialize)]
659pub struct RunsArgs {
660 pub repo: RepoPath,
661 pub viewer: Viewer,
662 /// A workflow's id or file name.
663 #[serde(default)]
664 pub workflow: Option<String>,
665 #[serde(default)]
666 pub branch: Option<String>,
667 #[serde(default)]
668 pub event: Option<String>,
669 /// The pull request's number.
670 #[serde(default)]
671 pub pull: Option<u32>,
672 #[serde(default)]
673 pub sha: Option<String>,
674 #[serde(default)]
675 pub limit: Option<u32>,
676}
677
678/// `run`. Returns `Outcome<RunDetail>`.
679#[derive(Debug, Serialize, Deserialize)]
680pub struct RunArgs {
681 pub repo: RepoPath,
682 pub viewer: Viewer,
683 pub id: String,
684 /// An earlier attempt; the latest when absent.
685 #[serde(default)]
686 pub attempt: Option<u64>,
687}
688
689/// `summaries`: the job summaries of a run's attempt (the latest when
690/// `attempt` is absent), jobs in the run's order, those with none left
691/// out. Returns `Outcome<Vec<JobSummary>>`.
692#[derive(Debug, Serialize, Deserialize)]
693pub struct SummariesArgs {
694 pub repo: RepoPath,
695 pub viewer: Viewer,
696 pub id: String,
697 #[serde(default)]
698 pub attempt: Option<u64>,
699}
700
701/// `job_log_text`: one job's whole log, any attempt's (by the id the run
702/// gave the job). Returns `Outcome<JobLogText>`.
703#[derive(Debug, Serialize, Deserialize)]
704pub struct JobLogTextArgs {
705 pub repo: RepoPath,
706 pub viewer: Viewer,
707 pub job: String,
708}
709
710/// `run_logs`: every job's whole log for an attempt of a run (the latest
711/// when `attempt` is absent), until they add up to `MAX_RUN_LOG_BYTES`;
712/// jobs past it come `omitted`, with no chunks. Returns
713/// `Outcome<Vec<JobLogText>>`.
714#[derive(Debug, Serialize, Deserialize)]
715pub struct RunLogsArgs {
716 pub repo: RepoPath,
717 pub viewer: Viewer,
718 pub id: String,
719 #[serde(default)]
720 pub attempt: Option<u64>,
721}
722
723/// The most log `run_logs` returns at once, in bytes.
724pub const MAX_RUN_LOG_BYTES: usize = 24 * 1024 * 1024;
725
726/// `logs`: a job's log after `after`. Returns `Outcome<JobLog>`.
727#[derive(Debug, Serialize, Deserialize)]
728pub struct LogsArgs {
729 pub repo: RepoPath,
730 pub viewer: Viewer,
731 pub job: String,
732 #[serde(default)]
733 pub after: u64,
734}
735
736/// `dispatch`: run a workflow that has `workflow_dispatch`. Members only.
737/// Returns `Outcome<WorkflowRun>`.
738#[derive(Debug, Serialize, Deserialize)]
739pub struct DispatchArgs {
740 pub actor: User,
741 pub repo: RepoPath,
742 /// A workflow's id or file name.
743 pub workflow: String,
744 /// A branch or tag; the default branch when absent.
745 #[serde(default, rename = "ref")]
746 pub git_ref: Option<String>,
747 #[serde(default)]
748 pub inputs: serde_json::Map<String, Value>,
749}
750
751/// `cancel` and `rerun`: every job, with `failed_only` the ones that did
752/// not succeed, or with `job` that one job (by its id in the run's latest
753/// attempt); each with the jobs that need them. `debug` runs the new
754/// attempt with debug logging. Members only. Returns `Outcome<WorkflowRun>`.
755#[derive(Debug, Serialize, Deserialize)]
756pub struct RunActionArgs {
757 pub actor: User,
758 pub repo: RepoPath,
759 pub id: String,
760 #[serde(default)]
761 pub failed_only: bool,
762 #[serde(default)]
763 pub job: Option<String>,
764 #[serde(default)]
765 pub debug: bool,
766 /// `cancel`: stop running jobs outright, without their cleanup steps.
767 #[serde(default)]
768 pub force: bool,
769}
770
771/// `set_workflow_enabled`. Members only. Returns `Outcome<Workflow>`.
772#[derive(Debug, Serialize, Deserialize)]
773pub struct SetWorkflowEnabledArgs {
774 pub actor: User,
775 pub repo: RepoPath,
776 pub workflow: String,
777 pub enabled: bool,
778}
779
780/// Whose secrets or variables: a repository's, or with only `workspace`,
781/// a workspace's.
782#[derive(Clone, Debug, Serialize, Deserialize)]
783pub struct SettingsOwner {
784 #[serde(default)]
785 pub repo: Option<RepoPath>,
786 #[serde(default)]
787 pub workspace: Option<String>,
788}
789
790/// `settings`: the secrets (`kind: secret`) or variables (`kind: variable`)
791/// of a repository, with its workspace's, or of a workspace. Members only.
792/// Returns `Outcome<Vec<Setting>>`.
793#[derive(Debug, Serialize, Deserialize)]
794pub struct SettingsArgs {
795 pub actor: User,
796 #[serde(flatten)]
797 pub owner: SettingsOwner,
798 pub kind: String,
799}
800
801/// `set_setting`: add or replace one. A repository's need a member; a
802/// workspace's an owner. Returns `Outcome<Setting>`.
803#[derive(Debug, Serialize, Deserialize)]
804pub struct SetSettingArgs {
805 pub actor: User,
806 #[serde(flatten)]
807 pub owner: SettingsOwner,
808 /// `secret` or `variable`. Changing a variable's row to `secret` seals
809 /// it; a secret cannot become a variable.
810 pub kind: String,
811 pub name: String,
812 /// The row to change. Left out, the key's row for every environment, as
813 /// GitHub's API addresses a secret by name alone.
814 #[serde(default)]
815 pub id: Option<String>,
816 /// Needed for a new row; left out, an existing row keeps its value.
817 #[serde(default)]
818 pub value: Option<String>,
819 /// `workflows` and/or `deployments`; left out, unchanged (both, for a
820 /// new row).
821 // Named as callers send it: an `alias` is not honoured beside the
822 // flattened owner in the Worker's build.
823 #[serde(default, rename = "availableTo")]
824 pub available_to: Option<Vec<String>>,
825 /// The environments it applies to; empty is every one. Left out,
826 /// unchanged.
827 #[serde(default)]
828 pub environments: Option<Vec<String>>,
829 /// A workspace's row: project slugs; empty for every one.
830 #[serde(default)]
831 pub projects: Option<Vec<String>>,
832 #[serde(default)]
833 pub note: Option<String>,
834 /// A secret's brokered hosts (`Setting::brokered_hosts`); empty stops
835 /// brokering it. Left out, unchanged.
836 #[serde(default, rename = "brokeredHosts")]
837 pub brokered_hosts: Option<Vec<String>>,
838}
839
840/// `set_managed_workflow`: installs, or replaces, a managed workflow in a
841/// repository (`g1t_actions::managed`): one that runs as if it were in
842/// `.g1t/workflows/` without being committed there, under the path
843/// `managed/<name>.yml`. For g1t's own services; never reached from the API.
844/// Refused when `source` is not a workflow g1t can read. Returns `bool`.
845#[derive(Debug, Serialize, Deserialize)]
846#[serde(rename_all = "camelCase")]
847pub struct SetManagedWorkflowArgs {
848 pub repo_id: String,
849 /// Letters, digits and hyphens: the file name its path ends with.
850 pub name: String,
851 pub source: String,
852 /// What keeps it: `deployments`, or a workspace's id.
853 pub origin: String,
854}
855
856/// `set_managed_deploy`: installs, replaces or removes the deploy workflow
857/// a project's deployments run through (`g1t_actions::managed`), named
858/// `deploy-<project>`, from the project's settings. Nothing deploys (both
859/// `previews` and `production` off) removes it. For the deployments
860/// service only. Returns `bool`, whether one is installed now.
861#[derive(Debug, Serialize, Deserialize)]
862#[serde(rename_all = "camelCase")]
863pub struct SetManagedDeployArgs {
864 pub repo_id: String,
865 pub project: String,
866 pub production_branch: String,
867 #[serde(default)]
868 pub root_dir: String,
869 #[serde(default)]
870 pub build_command: String,
871 #[serde(default)]
872 pub output_dir: String,
873 pub previews: bool,
874 pub production: bool,
875}
876
877/// A workflow a workspace's owners added to its repositories
878/// (`g1t_actions::managed::Target`): it runs in each repository it targets
879/// as that repository's own, with its token and secrets, under the path
880/// `managed/<name>.yml`, from a copy of its source taken when it was saved.
881#[derive(Clone, Debug, Serialize, Deserialize)]
882#[serde(rename_all = "camelCase")]
883pub struct WorkspaceManagedWorkflow {
884 /// Lowercase letters, digits and hyphens: its path is
885 /// `managed/<name>.yml`.
886 pub name: String,
887 pub path: String,
888 /// Its `name:`, as repositories list it; a repository's workflow of
889 /// this name takes a default one's place.
890 pub workflow_name: String,
891 /// Where it was copied from: `owner/repo/path@ref`, a repository of the
892 /// same workspace.
893 pub source: String,
894 /// The commit it was copied at.
895 pub source_sha: Option<String>,
896 /// Whether the source repository is private, so the workflow runs in
897 /// private repositories only.
898 pub source_private: bool,
899 /// `required` or `default`.
900 pub mode: String,
901 /// Names and patterns of the repositories it runs in; empty is every one.
902 pub repositories: Vec<String>,
903 /// `all`, `public` or `private`.
904 pub visibility: String,
905 /// The copy that runs.
906 pub content: String,
907 pub created_at: String,
908 pub updated_at: String,
909 pub updated_by: String,
910}
911
912/// `workspace_managed_workflows`: owners only. Returns
913/// `Outcome<Vec<WorkspaceManagedWorkflow>>`.
914#[derive(Debug, Serialize, Deserialize)]
915pub struct WorkspaceManagedWorkflowsArgs {
916 pub viewer: Viewer,
917 pub workspace: String,
918}
919
920/// `set_workspace_managed_workflow`: owners only. Adds one (`create`, which
921/// needs `source` and `mode`) or changes one; fields left out stay as they
922/// are. The source is copied again when it is given or `refresh` is set.
923/// Refused when the source is not a workflow file in a repository of the
924/// workspace, or is private while the workflow could run in a public
925/// repository. Returns `Outcome<WorkspaceManagedWorkflow>`.
926#[derive(Debug, Serialize, Deserialize)]
927#[serde(rename_all = "camelCase")]
928pub struct SetWorkspaceManagedWorkflowArgs {
929 pub actor: User,
930 pub workspace: String,
931 pub name: String,
932 #[serde(default)]
933 pub create: bool,
934 /// `owner/repo/.g1t/workflows/file.yml@ref`.
935 #[serde(default)]
936 pub source: Option<String>,
937 #[serde(default)]
938 pub mode: Option<String>,
939 #[serde(default)]
940 pub repositories: Option<Vec<String>>,
941 #[serde(default)]
942 pub visibility: Option<String>,
943 #[serde(default)]
944 pub refresh: bool,
945}
946
947/// `remove_workspace_managed_workflow`: owners only. Its runs stay.
948/// Returns `Outcome<bool>`, whether there was one.
949#[derive(Debug, Serialize, Deserialize)]
950pub struct RemoveWorkspaceManagedWorkflowArgs {
951 pub actor: User,
952 pub workspace: String,
953 pub name: String,
954}
955
956/// `remove_managed_workflow`: takes a managed workflow out of a repository.
957/// Its runs stay. Returns `bool`, whether there was one.
958#[derive(Debug, Serialize, Deserialize)]
959#[serde(rename_all = "camelCase")]
960pub struct RemoveManagedWorkflowArgs {
961 pub repo_id: String,
962 pub name: String,
963}
964
965/// `resolve_settings`: the secrets and variables one reader gets, for the
966/// services that hand them out (the deployments service). Returns
967/// `ResolvedSettings`.
968#[derive(Debug, Serialize, Deserialize)]
969#[serde(rename_all = "camelCase")]
970pub struct ResolveSettingsArgs {
971 pub repo_id: String,
972 pub repo: RepoPath,
973 /// The project being read for; its repository's primary project if left
974 /// out.
975 #[serde(default)]
976 pub project_id: Option<String>,
977 #[serde(default)]
978 pub project_slug: Option<String>,
979 /// `workflows` or `deployments`.
980 pub consumer: String,
981 /// The environment being read for, such as `production` or `preview`.
982 #[serde(default)]
983 pub environment: Option<String>,
984 /// Whether the run is trusted; an untrusted one gets no secrets.
985 pub trusted: bool,
986}
987
988#[derive(Debug, Default, Serialize, Deserialize)]
989pub struct ResolvedSettings {
990 pub secrets: serde_json::Map<String, serde_json::Value>,
991 pub variables: serde_json::Map<String, serde_json::Value>,
992}
993
994/// `delete_setting`. Returns `Outcome<bool>`.
995#[derive(Debug, Serialize, Deserialize)]
996pub struct DeleteSettingArgs {
997 pub actor: User,
998 #[serde(flatten)]
999 pub owner: SettingsOwner,
1000 pub kind: String,
1001 pub name: String,
1002 /// One row; left out, every row of the key.
1003 #[serde(default)]
1004 pub id: Option<String>,
1005}
1006
1007/// `job_spec` and `job_report`: the sandbox running a job, with the job's
1008/// own token. `report` is one of:
1009/// `{"kind": "step", "number", "status", "conclusion"}`,
1010/// `{"kind": "log", "step", "text"}`,
1011/// `{"kind": "annotation", "level", "message", "title", "file", "line"}`,
1012/// `{"kind": "done", "conclusion", "outputs", "reason"}`.
1013#[derive(Debug, Serialize, Deserialize)]
1014pub struct JobCallArgs {
1015 pub job: String,
1016 pub token: String,
1017 #[serde(default)]
1018 pub report: Value,
1019 /// `job_spec` only: the harness takes a new token with the spec, and
1020 /// the one it asked with stops working, so a copy of it left on the
1021 /// runner's computer cannot fetch the job's secrets again. Harnesses
1022 /// that predate it never ask, and keep their token.
1023 #[serde(default)]
1024 pub rotate: bool,
1025 /// `job_spec` only: the harness on a self-hosted runner can pass the
1026 /// job's requests to a brokered secret's hosts through g1t
1027 /// (`POST /actions/jobs/{job}/broker`), so its spec lists each
1028 /// stand-in's hosts, never a value. Harnesses that predate it never
1029 /// ask, and their job's log says the stand-ins will not be filled in.
1030 #[serde(default)]
1031 pub broker: bool,
1032}
1033
1034/// What the runner needs to start a job's sandbox.
1035#[derive(Debug, Serialize, Deserialize)]
1036#[serde(rename_all = "camelCase")]
1037pub struct StartJobArgs {
1038 pub job: String,
1039 pub token: String,
1040 pub repo: RepoPath,
1041 /// Minutes before the job is stopped.
1042 pub timeout_minutes: u32,
1043 /// The workflow file the job is in (`.g1t/workflows/deploy.yml`), for
1044 /// the guardrails' workflow-only domains.
1045 #[serde(default)]
1046 pub workflow: Option<String>,
1047 /// The environment the job names with `environment:`, when it names
1048 /// one plainly (not with an expression).
1049 #[serde(default)]
1050 pub environment: Option<String>,
1051 /// Whether its run is trusted: not a pull request from a fork. Only a
1052 /// trusted run's jobs reach workflow-only domains.
1053 #[serde(default)]
1054 pub trusted: bool,
1055 /// The machine its `runs-on` asked for, by label (`instance_for`):
1056 /// `g1t-2core` or `g1t-4core`; absent, the standard one.
1057 #[serde(default)]
1058 pub instance: Option<String>,
1059 /// Whether the job may be given brokered secrets, so the runner sends
1060 /// its HTTP and HTTPS through the Worker even when its network is open.
1061 #[serde(default)]
1062 pub brokered: bool,
1063}
1064
1065/// A size of machine g1t runs workflow jobs on, asked for by a label in
1066/// `runs-on`. Each is a Cloudflare Containers instance type; it costs what
1067/// that instance costs g1t, plus the margin, like any sandbox time.
1068#[derive(Clone, Copy, Debug, PartialEq)]
1069pub struct InstanceType {
1070 /// The `runs-on` label, or `standard` for the default.
1071 pub label: &'static str,
1072 /// The Containers instance type.
1073 pub container: &'static str,
1074 pub vcpu: f64,
1075 pub memory_gib: f64,
1076 pub disk_gb: f64,
1077 /// What a second of it costs g1t as a multiple of the standard
1078 /// machine's, with its vCPUs as busy (Cloudflare's list prices:
1079 /// memory $0.0000025 a GiB-second, disk $0.00000007 a GB-second, vCPU
1080 /// $0.00002 a second). Used to reserve before a job starts, and to
1081 /// price a job that did not report its own CPU.
1082 pub price_scale: f64,
1083}
1084
1085/// The default: what `ubuntu-latest` and every other hosted label get.
1086pub const STANDARD_INSTANCE: InstanceType =
1087 InstanceType { label: "standard", container: "standard-1", vcpu: 0.5, memory_gib: 4.0, disk_gb: 8.0, price_scale: 1.0 };
1088
1089/// Every machine a workflow job can ask for, the default first.
1090pub const INSTANCE_TYPES: [InstanceType; 3] = [
1091 STANDARD_INSTANCE,
1092 InstanceType { label: "g1t-2core", container: "standard-3", vcpu: 2.0, memory_gib: 8.0, disk_gb: 16.0, price_scale: 2.8 },
1093 InstanceType { label: "g1t-4core", container: "standard-4", vcpu: 4.0, memory_gib: 12.0, disk_gb: 20.0, price_scale: 5.1 },
1094];
1095
1096/// The machine a job's `runs-on` labels ask for: the largest named, or the
1097/// standard one. Labels compare without regard to case.
1098pub fn instance_for(labels: &[String]) -> InstanceType {
1099 INSTANCE_TYPES
1100 .iter()
1101 .rev()
1102 .find(|instance| instance.label != STANDARD_INSTANCE.label && labels.iter().any(|label| label.trim().eq_ignore_ascii_case(instance.label)))
1103 .copied()
1104 .unwrap_or(STANDARD_INSTANCE)
1105}
1106
1107/// An instance type by its label, if it is one.
1108pub fn instance_named(label: &str) -> Option<InstanceType> {
1109 INSTANCE_TYPES.iter().find(|instance| instance.label.eq_ignore_ascii_case(label.trim())).copied()
1110}
1111
1112// ── The cache (actions/cache) ─────────────────────────────────────────────
1113//
1114// Entries are kept in R2 by the API (the ACTIONS_CACHE bucket) and listed
1115// here, by the actions service, which decides what is found, what fits and
1116// what is evicted. A sandbox reaches these through the API with its job's
1117// token: `/actions/jobs/{job}/cache` (see apps/api/src/blobs.rs).
1118
1119/// The largest one cache entry may be, compressed.
1120pub const CACHE_MAX_ENTRY_BYTES: u64 = 2 * 1024 * 1024 * 1024;
1121/// What one repository's entries may hold together. Saving past it evicts
1122/// the entries restored longest ago.
1123pub const CACHE_REPO_QUOTA_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1124/// An entry not restored for this long is deleted.
1125pub const CACHE_UNUSED_DAYS: u64 = 7;
1126/// An entry is deleted this long after it was saved, however often it is
1127/// restored (the bucket's own lifecycle rule deletes objects at 30 days).
1128pub const CACHE_MAX_AGE_DAYS: u64 = 28;
1129/// An upload is sent in parts of this size (the last may be smaller).
1130pub const CACHE_PART_BYTES: u64 = 32 * 1024 * 1024;
1131/// What R2 charges g1t to store a GB for a month, in millionths of a
1132/// dollar ($0.015): what the cache's storage is charged at, plus the margin.
1133pub const CACHE_MICROS_PER_GB_MONTH: i64 = 15_000;
1134
1135/// `cache_lookup`: the entry a job restores: its key exactly, else the
1136/// newest whose key starts with one of `restore`, in order.
1137/// Returns `Outcome<Option<CacheHit>>`.
1138#[derive(Debug, Serialize, Deserialize)]
1139pub struct CacheLookupArgs {
1140 pub job: String,
1141 pub token: String,
1142 pub key: String,
1143 #[serde(default)]
1144 pub restore: Vec<String>,
1145 /// The entry's version, a hash of its paths and compression, as the
1146 /// toolkit's client and g1t's runner both send it: only an entry of the
1147 /// same version is found. `None` from runners that send none, whose
1148 /// entries have none.
1149 #[serde(default)]
1150 pub version: Option<String>,
1151}
1152
1153#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1154pub struct CacheHit {
1155 pub key: String,
1156 pub object: String,
1157 pub size: u64,
1158 /// When it was saved, RFC 3339.
1159 #[serde(default)]
1160 pub created_at: String,
1161 /// A signed token for downloading it through the toolkit's blob
1162 /// endpoint, when the lookup came with a version.
1163 #[serde(default)]
1164 pub blob: Option<String>,
1165}
1166
1167/// `cache_reserve`: a job about to save `size` bytes under `key`. Refused
1168/// when the key is taken (`conflict`: keys are written once) or the entry
1169/// is too large. Returns `Outcome<CacheReservation>`.
1170#[derive(Debug, Serialize, Deserialize)]
1171pub struct CacheReserveArgs {
1172 pub job: String,
1173 pub token: String,
1174 pub key: String,
1175 /// Its size, when known before it is sent (the toolkit's newer client
1176 /// says only when it finishes: 0 then).
1177 pub size: u64,
1178 /// As in `CacheLookupArgs`.
1179 #[serde(default)]
1180 pub version: Option<String>,
1181}
1182
1183#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1184pub struct CacheReservation {
1185 pub id: String,
1186 /// Where the API puts it in R2.
1187 pub object: String,
1188 /// The entry's number, which the toolkit's older protocol names it by.
1189 #[serde(default)]
1190 pub number: u64,
1191 /// Its R2 upload, once one is started.
1192 #[serde(default)]
1193 pub upload: Option<String>,
1194 /// A signed token for sending its parts through the toolkit's blob
1195 /// endpoint, once its upload is started.
1196 #[serde(default)]
1197 pub blob: Option<String>,
1198}
1199
1200/// `cache_upload`: an entry a job is still uploading, by its number or by
1201/// key and version. Returns `Outcome<CacheReservation>`, with `upload` and
1202/// `blob` set once its upload has been started.
1203#[derive(Debug, Serialize, Deserialize)]
1204pub struct CacheUploadArgs {
1205 pub job: String,
1206 pub token: String,
1207 #[serde(default)]
1208 pub number: Option<u64>,
1209 #[serde(default)]
1210 pub key: Option<String>,
1211 #[serde(default)]
1212 pub version: Option<String>,
1213}
1214
1215/// `cache_commit`: the upload of `id` is complete, at `size` bytes. Returns
1216/// `Outcome<CacheCommitted>`: the objects of entries it evicted, which the
1217/// API deletes from R2.
1218#[derive(Debug, Serialize, Deserialize)]
1219pub struct CacheCommitArgs {
1220 pub job: String,
1221 pub token: String,
1222 pub id: String,
1223 pub size: u64,
1224}
1225
1226#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1227pub struct CacheCommitted {
1228 pub evicted: Vec<String>,
1229}
1230
1231/// `cache_abort`: an upload that will not finish; its reservation goes.
1232/// Returns `Outcome<bool>`.
1233#[derive(Debug, Serialize, Deserialize)]
1234pub struct CacheAbortArgs {
1235 pub job: String,
1236 pub token: String,
1237 pub id: String,
1238}
1239
1240// ── Artifacts (actions/upload-artifact) ───────────────────────────────────
1241//
1242// Kept in R2 by the API (the ACTIONS_CACHE bucket, under `a/`) and listed
1243// here, by the actions service, which decides names, sizes and how long
1244// each is kept. A sandbox reaches them with its job's token
1245// (`/actions/jobs/{job}/artifacts…`) or, through the toolkit's protocol,
1246// with its runtime token (`ACTIONS_RUNTIME_TOKEN`); people through the
1247// REST API and the run's page.
1248
1249/// The largest one artifact may be.
1250pub const ARTIFACT_MAX_BYTES: u64 = 5 * 1024 * 1024 * 1024;
1251/// What one run's artifacts may hold together.
1252pub const RUN_ARTIFACTS_MAX_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1253/// How long artifacts are kept unless a repository says otherwise.
1254pub const ARTIFACT_RETENTION_DEFAULT_DAYS: u32 = 14;
1255/// The longest a repository may keep them.
1256pub const ARTIFACT_RETENTION_MAX_DAYS: u32 = 90;
1257/// A native upload is sent in parts of this size (the last may be smaller).
1258pub const ARTIFACT_PART_BYTES: u64 = 32 * 1024 * 1024;
1259
1260/// An artifact, as the API and the site show it.
1261#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1262pub struct Artifact {
1263 pub id: u64,
1264 pub name: String,
1265 pub size: u64,
1266 /// `sha256:<hex>`, when the uploader said.
1267 pub digest: Option<String>,
1268 /// `zip`, or `tgz` for one an older runner sent.
1269 pub format: String,
1270 pub run_id: String,
1271 pub job_id: String,
1272 pub repo_id: String,
1273 /// Whether it has expired or been deleted (its bytes are gone).
1274 pub expired: bool,
1275 pub created_at: String,
1276 pub updated_at: String,
1277 pub expires_at: String,
1278 /// The run's branch and commit, for the REST shape.
1279 #[serde(default)]
1280 pub head_branch: Option<String>,
1281 #[serde(default)]
1282 pub head_sha: Option<String>,
1283}
1284
1285/// An artifact with where its bytes are, and a signed token for them.
1286#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1287pub struct ArtifactBlob {
1288 pub artifact: Artifact,
1289 pub object: String,
1290 /// For the toolkit's blob endpoint (`/actions/toolkit/blobs/{blob}`).
1291 pub blob: String,
1292}
1293
1294/// A page of artifacts, in GitHub's shape.
1295#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1296pub struct ArtifactList {
1297 pub total_count: u64,
1298 pub artifacts: Vec<Artifact>,
1299}
1300
1301/// `artifact_reserve`: a job about to upload an artifact. Refused when its
1302/// run has one of that name and `overwrite` is not set (`conflict`), or it
1303/// is too large. Returns `Outcome<ArtifactReservation>`.
1304#[derive(Debug, Default, Serialize, Deserialize)]
1305pub struct ArtifactReserveArgs {
1306 pub job: String,
1307 /// The job's token, or its runtime token.
1308 pub token: String,
1309 pub name: String,
1310 /// Its size, when known before it is sent (0 otherwise).
1311 #[serde(default)]
1312 pub size: u64,
1313 /// Days to keep it: 0 for the repository's default; at most the
1314 /// repository's setting.
1315 #[serde(default)]
1316 pub retention_days: u32,
1317 /// When to expire it, RFC 3339, as the toolkit says it (in place of
1318 /// `retention_days`).
1319 #[serde(default)]
1320 pub expires_at: Option<String>,
1321 #[serde(default)]
1322 pub overwrite: bool,
1323 /// `zip` (the default) or `tgz`.
1324 #[serde(default)]
1325 pub format: Option<String>,
1326}
1327
1328#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1329pub struct ArtifactReservation {
1330 pub id: u64,
1331 /// Where the API puts it in R2.
1332 pub object: String,
1333 /// The days it will be kept, and until when.
1334 pub retention_days: u32,
1335 pub expires_at: String,
1336}
1337
1338/// `artifact_commit`: its upload is complete, at `size` bytes. The artifact
1339/// is named by `id`, or by `name` in the job's run (the toolkit's way).
1340/// Returns `Outcome<Artifact>`.
1341#[derive(Debug, Default, Serialize, Deserialize)]
1342pub struct ArtifactCommitArgs {
1343 pub job: String,
1344 pub token: String,
1345 #[serde(default)]
1346 pub id: Option<u64>,
1347 #[serde(default)]
1348 pub name: Option<String>,
1349 pub size: u64,
1350 #[serde(default)]
1351 pub digest: Option<String>,
1352}
1353
1354/// `job_artifacts`: a running job listing the artifacts of its own run, or
1355/// of another run of its repository (`run_id`), narrowed by `name` or
1356/// `id`: `Outcome<Vec<Artifact>>`. `job_artifact` gives the one named, with
1357/// a token to download it: `Outcome<ArtifactBlob>`. `job_delete_artifact`
1358/// deletes one of its own run's: `Outcome<Artifact>`. `artifact_abort`
1359/// gives up an upload by `id`: `Outcome<bool>`.
1360#[derive(Debug, Default, Serialize, Deserialize)]
1361pub struct JobArtifactsArgs {
1362 pub job: String,
1363 pub token: String,
1364 #[serde(default)]
1365 pub run_id: Option<String>,
1366 #[serde(default)]
1367 pub name: Option<String>,
1368 #[serde(default)]
1369 pub id: Option<u64>,
1370}
1371
1372/// `artifacts`: a repository's artifacts, newest first, or one run's.
1373/// Anyone who can see the repository. Returns `Outcome<ArtifactList>`.
1374#[derive(Debug, Serialize, Deserialize)]
1375pub struct ArtifactsArgs {
1376 pub repo: RepoPath,
1377 pub viewer: Viewer,
1378 #[serde(default)]
1379 pub run: Option<String>,
1380 #[serde(default)]
1381 pub name: Option<String>,
1382 #[serde(default)]
1383 pub page: Option<u32>,
1384 #[serde(default)]
1385 pub per_page: Option<u32>,
1386}
1387
1388/// `artifact` (`Outcome<Artifact>`) and `artifact_download`
1389/// (`Outcome<ArtifactBlob>`, with a token good for a few minutes): one
1390/// artifact by `id`, or by `name` within `run`. Anyone who can see the
1391/// repository.
1392#[derive(Debug, Serialize, Deserialize)]
1393pub struct ArtifactArgs {
1394 pub repo: RepoPath,
1395 pub viewer: Viewer,
1396 #[serde(default)]
1397 pub id: Option<u64>,
1398 #[serde(default)]
1399 pub run: Option<String>,
1400 #[serde(default)]
1401 pub name: Option<String>,
1402}
1403
1404/// `delete_artifact`: needs the Write role. Returns `Outcome<Artifact>`.
1405#[derive(Debug, Serialize, Deserialize)]
1406pub struct DeleteArtifactArgs {
1407 pub actor: User,
1408 pub repo: RepoPath,
1409 pub id: u64,
1410}
1411
1412/// `artifact_retention`: anyone who can see the repository. With `days`,
1413/// sets it, which needs the Maintain role. Returns
1414/// `Outcome<ArtifactRetention>`.
1415#[derive(Debug, Serialize, Deserialize)]
1416pub struct ArtifactRetentionArgs {
1417 pub repo: RepoPath,
1418 pub viewer: Viewer,
1419 #[serde(default)]
1420 pub days: Option<u32>,
1421}
1422
1423/// GitHub's shape: the days artifacts are kept by default, and the most a
1424/// repository may choose.
1425#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1426pub struct ArtifactRetention {
1427 pub days: u32,
1428 pub maximum_allowed_days: u32,
1429}
1430
1431// ── The toolkit's protocols ───────────────────────────────────────────────
1432//
1433// Actions built on GitHub's toolkit (`@actions/cache`, `@actions/artifact`,
1434// `@actions/core`'s `getIDToken`) reach g1t with the job's runtime token,
1435// `ACTIONS_RUNTIME_TOKEN`: a JSON Web Token whose `scp` names the run and
1436// job, signed with a key derived from the job's own token, so the actions
1437// service checks it without keeping another secret. Cache and artifact
1438// operations above take it in place of the job's token.
1439
1440/// `runtime_auth`: which job a runtime token is, while it runs:
1441/// `Outcome<RuntimeJob>`. `oidc_claims` takes the same and returns
1442/// `Outcome<Value>`: the claims of the job's OIDC token, less `iss`, `aud`,
1443/// `jti` and the times, or `forbidden` when the job's `permissions` do not
1444/// give it `id-token: write`.
1445#[derive(Debug, Serialize, Deserialize)]
1446pub struct RuntimeAuthArgs {
1447 pub job: String,
1448 pub token: String,
1449}
1450
1451#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1452pub struct RuntimeJob {
1453 pub job: String,
1454 pub run: String,
1455 pub repo_id: String,
1456 pub namespace: String,
1457 /// `owner/name`.
1458 pub repository: String,
1459}
1460
1461/// What a signed blob token lets its holder do.
1462#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1463pub struct BlobGrant {
1464 /// `cache` or `artifact`.
1465 pub kind: String,
1466 /// The entry's id: a cache entry's `cache_…`, an artifact's number.
1467 pub id: String,
1468 pub object: String,
1469 /// The R2 upload it sends parts to; `None` for a download.
1470 pub upload: Option<String>,
1471 /// For a download: what to call the file, and its type.
1472 #[serde(default)]
1473 pub filename: Option<String>,
1474 #[serde(default)]
1475 pub content_type: Option<String>,
1476}
1477
1478/// `blob_sign`: a token for uploading an entry the job reserved, to the R2
1479/// upload the API started for it. Returns `Outcome<String>`.
1480#[derive(Debug, Serialize, Deserialize)]
1481pub struct BlobSignArgs {
1482 pub job: String,
1483 pub token: String,
1484 /// `cache` or `artifact`.
1485 pub kind: String,
1486 pub id: String,
1487 pub upload: String,
1488}
1489
1490/// `blob_open`: what a signed token grants, while it is good and its entry
1491/// is there: `Outcome<BlobGrant>`. `blob_part` records a part sent with an
1492/// upload token (`part`, `etag`, `size`): `Outcome<bool>`. `blob_parts`
1493/// gives the parts recorded, in order: `Outcome<Vec<BlobPart>>`, and
1494/// `blob_done` forgets them: `Outcome<bool>`.
1495#[derive(Debug, Default, Serialize, Deserialize)]
1496pub struct BlobArgs {
1497 pub blob: String,
1498 #[serde(default)]
1499 pub part: u32,
1500 #[serde(default)]
1501 pub etag: String,
1502 #[serde(default)]
1503 pub size: u64,
1504}
1505
1506#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1507pub struct BlobPart {
1508 pub part: u32,
1509 pub etag: String,
1510 pub size: u64,
1511}
1512
1513#[cfg(test)]
1514mod instance_tests {
1515 use super::*;
1516
1517 fn labels(given: &[&str]) -> Vec<String> {
1518 given.iter().map(|l| (*l).to_owned()).collect()
1519 }
1520
1521 #[test]
1522 fn runs_on_picks_the_machine() {
1523 assert_eq!(instance_for(&labels(&["ubuntu-latest"])).container, "standard-1");
1524 assert_eq!(instance_for(&labels(&[])).label, "standard");
1525 assert_eq!(instance_for(&labels(&["g1t-4core"])).container, "standard-4");
1526 assert_eq!(instance_for(&labels(&["ubuntu-latest", "G1T-2Core"])).container, "standard-3");
1527 // Both named: the larger.
1528 assert_eq!(instance_for(&labels(&["g1t-2core", "g1t-4core"])).label, "g1t-4core");
1529 assert_eq!(instance_named("g1t-4core").map(|i| i.vcpu), Some(4.0));
1530 assert_eq!(instance_named("standard"), Some(STANDARD_INSTANCE));
1531 assert_eq!(instance_named("g1t-64core"), None);
1532 }
1533
1534 #[test]
1535 fn start_args_from_older_callers_read() {
1536 let args: StartJobArgs = serde_json::from_value(serde_json::json!({
1537 "job": "job_1", "token": "t", "repo": { "namespace": "acme", "name": "web" }, "timeoutMinutes": 30
1538 }))
1539 .unwrap();
1540 assert!(args.workflow.is_none() && args.environment.is_none() && !args.trusted && args.instance.is_none());
1541 }
1542}
1543
1544#[cfg(test)]
1545mod setting_args_tests {
1546 use super::*;
1547
1548 #[test]
1549 fn who_reads_a_row_is_read_as_the_site_and_api_send_it() {
1550 let args: SetSettingArgs = serde_json::from_value(serde_json::json!({
1551 "actor": { "id": "usr_1", "username": "a" },
1552 "repo": { "namespace": "acme", "name": "web" },
1553 "kind": "secret",
1554 "name": "STRIPE_KEY",
1555 "availableTo": ["deployments"],
1556 "environments": ["production"],
1557 }))
1558 .unwrap();
1559 assert_eq!(args.available_to, Some(vec!["deployments".to_owned()]));
1560 }
1561}