Sign in

flagon-io/g1t

public

g1t/packages/contracts/src/work.ts

734 lines24,983 bytesCodeBlame

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Initial g1t: services, event bus, intents and attempts1import type { User, Viewer } from "./identity";
2import type { RepoPath } from "./repos";
3import type { Result } from "./result";
4
Issues and pull requests replace intents and attempts5/**
6 * The filter on lists of issues and pull requests. An open pull request is
7 * a draft or one ready for review; a closed one was merged or closed
8 * without merging.
9 */
10export type State = "open" | "closed";
11
12/** Why an issue was closed. */
13export type IssueReason = "completed" | "not_planned";
Initial g1t: services, event bus, intents and attempts14
Issues and pull requests replace intents and attempts15/**
16 * Something that should change in a repository: a bug, a feature, a
17 * question. Opened by a person, an agent or an integration. Pull requests
18 * are made against it; the one that is merged resolves it.
19 *
20 * Issues and pull requests share one sequence of numbers per repository.
21 */
22export type Issue = {
Initial g1t: services, event bus, intents and attempts23 id: string;
24 repoId: string;
Issues and pull requests replace intents and attempts25 /** Shown as `#12`. */
Initial g1t: services, event bus, intents and attempts26 number: number;
27 title: string;
Issues and pull requests replace intents and attempts28 /** Markdown. Also what an agent is given to work from. */
29 body: string;
30 labels: string[];
31 /** Commands that must pass for a pull request to be accepted. */
Initial g1t: services, event bus, intents and attempts32 checks: string[];
Issues and pull requests replace intents and attempts33 state: State;
34 /** Set when closed. */
35 reason: IssueReason | null;
36 /** The number of the pull request whose merge closed this issue. */
37 resolvedBy: number | null;
Initial g1t: services, event bus, intents and attempts38 author: User;
Work service in Rust, with RFC 3339 timestamps39 /** RFC 3339. */
40 createdAt: string;
Issues and pull requests replace intents and attempts41 /** RFC 3339. */
42 updatedAt: string;
43 /** RFC 3339. */
44 closedAt: string | null;
45 /** Pull requests made against this issue, in any state. */
46 pullCount: number;
47 commentCount: number;
Agents as a team: lifecycle, merge queue, billing and a new shell48 /** Usernames of the people it is assigned to. */
49 assignees: string[];
50 /** The numbers of the issues that have to be merged before this one is worked on. */
51 blockedBy: number[];
52 /**
53 * Whether a g1t agent takes it as soon as it can: at once, or when what it
54 * is blocked by has merged.
55 */
56 queued: boolean;
57 /**
58 * The agent working on it now: the one behind its newest pull request
59 * that is still in progress in a fork, such as `g1t-agent`.
60 */
61 agent: string | null;
Initial g1t: services, event bus, intents and attempts62};
63
Issues and pull requests replace intents and attempts64/** `draft` is still being worked on; `open` is ready for review. */
65export type PullStatus = "draft" | "open" | "merged" | "closed";
Initial g1t: services, event bus, intents and attempts66
67/** Where the agent runs: on g1t's sandboxes, or in someone's own session. */
Issues and pull requests replace intents and attempts68export type Runtime = "hosted" | "external";
Initial g1t: services, event bus, intents and attempts69
Pull requests from branches70/**
71 * A proposed change. It is made either in a fork created for it, which is
72 * how agents work, or on a branch pushed to the repository itself.
73 */
Issues and pull requests replace intents and attempts74export type Pull = {
Initial g1t: services, event bus, intents and attempts75 id: string;
76 repoId: string;
Issues and pull requests replace intents and attempts77 /** Shown as `#12`. */
Initial g1t: services, event bus, intents and attempts78 number: number;
Issues and pull requests replace intents and attempts79 /** The number of the issue this is for, if any. */
80 issue: number | null;
81 title: string;
82 /** Markdown: what changed and why. Set when marked ready. */
83 body: string | null;
Initial g1t: services, event bus, intents and attempts84 /** A label for the agent doing the work, e.g. `claude-code`. */
85 agent: string;
Issues and pull requests replace intents and attempts86 runtime: Runtime;
87 status: PullStatus;
Pull requests from branches88 /** The fork holding the change, unless it is on a branch. */
89 fork: RepoPath | null;
Diffs on attempts; hosted agent presented as the g1t agent90 /** The fork's repository id. */
Pull requests from branches91 forkRepoId: string | null;
92 /** The branch of the repository holding the change, unless it is in a fork. */
93 branch: string | null;
Initial g1t: services, event bus, intents and attempts94 headCommit: string | null;
Diffs on attempts; hosted agent presented as the g1t agent95 /**
Issues and pull requests replace intents and attempts96 * For a merged pull request, what the branch pointed to before the merge.
97 * Comparing against it shows what the pull request changed.
98 */
99 mergeBase: string | null;
100 /** Username of whoever merged it. */
101 mergedBy: string | null;
102 /** RFC 3339. */
103 mergedAt: string | null;
104 /**
105 * Set on a pull request closed because another one for the same issue was
106 * merged: that one's number.
Diffs on attempts; hosted agent presented as the g1t agent107 */
Issues and pull requests replace intents and attempts108 supersededBy: number | null;
Acceptance checks in sandboxes, line comments and review verdicts109 /**
110 * Where the latest run of the issue's acceptance checks stands, if there
111 * has been one against the current head.
112 */
113 checkStatus: CheckStatus | null;
Agents as a team: lifecycle, merge queue, billing and a new shell114 /** The files it changes, as of its latest push. */
115 files: ChangedFile[];
116 /** Usernames of the people it is assigned to. */
117 assignees: string[];
118 /**
119 * Those whose review was asked for: usernames, and `g1t-agent` when a g1t
120 * agent was asked.
121 */
122 reviewers: string[];
Issues and pull requests replace intents and attempts123 author: User;
Work service in Rust, with RFC 3339 timestamps124 /** RFC 3339. */
125 createdAt: string;
126 /** RFC 3339. */
127 updatedAt: string;
Initial g1t: services, event bus, intents and attempts128};
129
Agents as a team: lifecycle, merge queue, billing and a new shell130/** One file a pull request changes, and by how much. */
131export type ChangedFile = { path: string; additions: number; deletions: number };
132
133/**
134 * Another pull request in progress that changes some of the same files. Two
135 * for the same issue are alternatives; two for different issues are heading
136 * for a conflict.
137 */
138export type Overlap = {
139 number: number;
140 title: string;
141 /** The number of the issue the other pull request is for. */
142 issue: number | null;
143 /** The files both change. */
144 paths: string[];
145};
146
Acceptance checks in sandboxes, line comments and review verdicts147/** `queued` waits for a sandbox; `errored` means the checks could not be run. */
148export type CheckStatus = "queued" | "running" | "passed" | "failed" | "errored";
149
150/** How one acceptance check went. */
151export type CheckResult = {
152 command: string;
153 passed: boolean;
154 /** Null when the command was stopped for taking too long. */
155 exitCode: number | null;
156 /** What the command printed; the end of it, when there was a lot. */
157 output: string;
158 durationMs: number;
159};
160
161/**
162 * One run of an issue's acceptance checks against a pull request's head, in
163 * a sandbox that holds nothing but that commit.
164 */
165export type CheckRun = {
166 id: string;
167 /** The commit that was checked. */
168 headCommit: string;
169 status: CheckStatus;
170 results: CheckResult[];
171 /** Why the checks could not be run, when `status` is `errored`. */
172 error: string | null;
173 /** RFC 3339. */
174 createdAt: string;
175 /** RFC 3339. */
176 finishedAt: string | null;
177};
178
179/** A reviewer's decision on a pull request. */
180export type Verdict = "approve" | "request_changes";
181
182/**
183 * A comment on an issue or a pull request. On a pull request it can sit on
184 * one line of the change, and it can carry a reviewer's verdict.
185 */
Issues and pull requests replace intents and attempts186export type Comment = {
187 id: string;
Agents as a team: lifecycle, merge queue, billing and a new shell188 /**
189 * Something a person or an agent wrote, or something that happened: an
190 * assignment, a review asked for, a close.
191 */
192 kind: "comment" | "event";
Issues and pull requests replace intents and attempts193 author: User;
Agents as a team: lifecycle, merge queue, billing and a new shell194 /**
195 * Markdown. For an event, what its author did, as the rest of a sentence
196 * that starts with their name: "assigned ana".
197 */
Issues and pull requests replace intents and attempts198 body: string;
Acceptance checks in sandboxes, line comments and review verdicts199 /** The file commented on, for a comment on a line. */
200 path: string | null;
201 /** The line of that file, as numbered after the change. */
202 line: number | null;
203 verdict: Verdict | null;
Issues and pull requests replace intents and attempts204 /** RFC 3339. */
205 createdAt: string;
206};
207
Acceptance checks in sandboxes, line comments and review verdicts208export type NewComment = {
209 /** May be empty when approving. */
210 body: string;
211 path?: string;
212 line?: number;
213 verdict?: Verdict;
214};
215
216/** What a sandbox needs to carry out a check run. */
217export type CheckJob = {
218 runId: string;
219 /** Lets the sandbox, and nothing else, report this run's results. */
220 token: string;
221 commands: string[];
222 /** The repository holding the commit: the fork, or the repository itself. */
223 source: RepoPath;
224 commit: string;
225 /** Who opened the pull request, and so can read its source. */
226 author: User;
227 /** Username of whoever wrote the checks: the issue's author. */
228 requestedBy: string;
229 repo: RepoPath;
230 number: number;
231};
232
233export type CheckReport = { results?: CheckResult[]; error?: string; skip?: boolean };
234
Initial g1t: services, event bus, intents and attempts235export type SessionEntryKind = "prompt" | "message" | "tool_call" | "tool_result" | "note";
236
Issues and pull requests replace intents and attempts237/** One step of an agent's session: the "why" behind a pull request's commits. */
Initial g1t: services, event bus, intents and attempts238export type SessionEntry = {
239 seq: number;
240 kind: SessionEntryKind;
241 text: string;
242 /** For tool calls and results. */
243 tool: string | null;
244 /** The fork's head commit when this entry was recorded, if known. */
245 commit: string | null;
Work service in Rust, with RFC 3339 timestamps246 /** RFC 3339. */
247 at: string;
Initial g1t: services, event bus, intents and attempts248};
249
250export type NewSessionEntry = Pick<SessionEntry, "kind" | "text"> &
Work service in Rust, with RFC 3339 timestamps251 Partial<Pick<SessionEntry, "tool" | "commit">>;
Initial g1t: services, event bus, intents and attempts252
Issues and pull requests replace intents and attempts253export type IssueDetail = {
254 issue: Issue;
255 /** Every pull request made against it, oldest first. */
256 pulls: Pull[];
257 comments: Comment[];
258};
Initial g1t: services, event bus, intents and attempts259
Issues and pull requests replace intents and attempts260export type PullDetail = {
261 pull: Pull;
262 /** The issue it is for, if any. */
263 issue: Issue | null;
264 comments: Comment[];
Acceptance checks in sandboxes, line comments and review verdicts265 /** The latest run of the issue's acceptance checks. */
266 checks: CheckRun | null;
Agents as a team: lifecycle, merge queue, billing and a new shell267 /** Other pull requests in progress that change the same files. */
268 overlaps: Overlap[];
269 /**
270 * Whether the branch it would merge into has moved on without it, so that
271 * it has to catch up before it can merge.
272 */
273 behind: boolean;
274 /** Whether a g1t agent is reviewing it right now. */
275 reviewPending: boolean;
276 /**
277 * Where it stands on its way to being merged, for a pull request g1t is
278 * seeing through. Null on anyone else's.
279 */
280 lifecycle: Lifecycle | null;
281 /**
282 * A merge was asked for while it was behind: g1t is bringing it up to
283 * date and will then land it.
284 */
285 landing: boolean;
286 /** Why g1t stopped working on it, if it did. */
287 stalled: string | null;
288};
289
290/**
291 * A step on the way from an assigned issue to a pull request that is ready
292 * to merge. g1t takes each one without being asked: `working` (the agent is
293 * making the change), `checking`, `reviewing`, `revising` (the agent is
294 * addressing failed checks or a review), `catching_up` (merging in the
295 * branch it would land on), then `ready` for a person to merge. `needs_you`
296 * means g1t has stopped and a person decides what happens next.
297 */
298export type Stage =
299 | "working"
300 | "checking"
301 | "reviewing"
302 | "revising"
303 | "catching_up"
304 | "queued"
305 | "ready"
306 | "needs_you";
307
308export type Lifecycle = {
309 stage: Stage;
310 /** One sentence saying what is happening, or why it stopped. */
311 detail: string;
312 /** How many times the agent has been sent back to revise it. */
313 revisions: number;
314};
315
316/** What the runner needs to carry out a step of a pull request's lifecycle. */
317export type LifecycleJob = {
318 pullId: string;
319 repo: RepoPath;
320 number: number;
321 /** Who the pull request belongs to. Sandboxes act as them. */
322 author: User;
323 /** The repository holding the change: its fork, or the repository itself. */
324 source: RepoPath;
325 /** The branch of the source holding the change; its default branch when null. */
326 branch: string | null;
327 defaultBranch: string;
328 title: string;
329 description: string;
330 issue: Issue | null;
331 /** For a revision: the failed checks or the review to address. */
332 feedback: string;
333 /** For a revision: which one this is, from 1. */
334 round: number;
335};
336
337/**
338 * `planning` while an agent reads the repository and writes it; `ready` for
339 * a person to read and apply; `failed` if it could not be written;
340 * `applied` once its issues are open.
341 */
342export type PlanStatus = "planning" | "ready" | "failed" | "applied";
343
344/** One issue a plan proposes. */
345export type PlannedIssue = {
346 title: string;
347 /** Markdown: what to change, where, and why. */
348 body: string;
349 labels: string[];
350 /** Commands that must pass once the change is made. */
351 checks: string[];
352 /** The files it will most likely change. */
353 files: string[];
354 /**
355 * The positions, counting from 1, of earlier issues in the plan that have
356 * to be merged first.
357 */
358 dependsOn: number[];
359 /** Its number, once the plan has been applied and it was kept. */
360 number: number | null;
361};
362
363/** An outcome someone wrote, and the issues an agent proposes to get there. */
364export type Plan = {
365 id: string;
366 repoId: string;
367 /** The outcome wanted, as written. */
368 brief: string;
369 status: PlanStatus;
370 /** The agent's account of how it split the work. */
371 summary: string;
372 issues: PlannedIssue[];
373 /** Why it could not be written, when `status` is `failed`. */
374 error: string | null;
375 author: User;
376 /** RFC 3339. */
377 createdAt: string;
378 /** RFC 3339. */
379 finishedAt: string | null;
380};
381
382/** What a sandbox needs to write a plan. */
383export type PlanJob = {
384 planId: string;
385 /** Lets the sandbox, and nothing else, report this plan. */
386 token: string;
387 brief: string;
388 repo: RepoPath;
Issues and pull requests replace intents and attempts389};
Initial g1t: services, event bus, intents and attempts390
Agents as a team: lifecycle, merge queue, billing and a new shell391/** An issue waiting for a g1t agent that can be given one now. */
392export type ReadyIssue = {
393 repo: RepoPath;
394 number: number;
395 /** Who queued it, on whose say-so the agent works. */
396 actor: User;
397};
398
399/**
400 * How a repository wants its pull requests handled. A repository that has
401 * changed nothing has the defaults.
402 */
403export type RepoSettings = {
404 /**
405 * Land a g1t agent's pull request without a person once it is ready:
406 * checks passed and approved as the settings below require.
407 */
408 autoMerge: boolean;
409 /**
410 * Refuse to merge a pull request that does not contain the default
411 * branch's latest commits, so that what merges is what was checked. When
412 * off, merging one that is behind brings it up to date first.
413 */
414 requireUpToDate: boolean;
415 /**
416 * How many approving reviews a pull request needs before it may merge. A
417 * reviewer who has since asked for changes blocks it.
418 */
419 requiredApprovals: number;
420 /** Whether a g1t agent's approval counts towards `requiredApprovals`. */
421 countAgentApprovals: boolean;
422 /** Whether a member may merge although the acceptance checks did not pass. */
423 allowIgnoringChecks: boolean;
424 /** Whether a g1t agent's pull request is reviewed by a second agent unasked. */
425 agentReview: boolean;
426 /**
427 * How many times a g1t agent is sent back to its pull request before a
428 * person is asked instead.
429 */
430 maxRevisions: number;
431 /**
432 * Merge through a queue: pull requests are tested together with those
433 * ahead of them, and only a combination that passed reaches the default
434 * branch.
435 */
436 mergeQueue: boolean;
437 /** Username of the member who last changed the settings, if anyone has. */
438 updatedBy: string | null;
439 /** RFC 3339. */
440 updatedAt: string | null;
441};
442
443/** The settings a member can change. */
444export type RepoSettingsInput = Omit<RepoSettings, "updatedBy" | "updatedAt">;
445
446/** The next step for a pull request g1t is seeing through, already claimed. */
447export type Advance =
448 | { action: "none" }
449 | { action: "review" | "revise" | "catch_up"; job: LifecycleJob };
450
451/** What a sandbox needs to review a pull request. */
452export type ReviewJob = {
453 runId: string;
454 /** Lets the sandbox, and nothing else, report this review. */
455 token: string;
456 /** The repository holding the commit: the fork, or the repository itself. */
457 source: RepoPath;
458 commit: string;
459 repo: RepoPath;
460 defaultBranch: string;
461 number: number;
462 title: string;
463 description: string;
464 /** The issue the pull request is for, which says what it should achieve. */
465 issue: Issue | null;
466 /** Who opened the pull request, and so can read its source. */
467 author: User;
468};
469
Issues and pull requests replace intents and attempts470export type OpenIssueInput = {
471 title: string;
472 body: string;
473 labels?: string[];
474 checks?: string[];
475};
476
Agents as a team: lifecycle, merge queue, billing and a new shell477export type UpdateIssueInput = {
478 title?: string;
479 body?: string;
480 labels?: string[];
481 /** Usernames of the people it is assigned to; replaces the whole set. */
482 assignees?: string[];
483};
Issues and pull requests replace intents and attempts484
485export type OpenPullInput = {
486 /** The number of the issue this is for. */
487 issue?: number;
488 /** Defaults to the issue's title; required without an issue. */
489 title?: string;
Pull requests from branches490 /** What changed and why. Usually set later, when a draft is marked ready. */
491 body?: string;
492 /**
493 * A branch of the repository that already holds the change. The pull
494 * request is then ready for review at once and has no fork.
495 */
496 branch?: string;
Issues and pull requests replace intents and attempts497 agent: string;
498 runtime: Runtime;
499};
Initial g1t: services, event bus, intents and attempts500
Issues and pull requests replace intents and attempts501/** Issues, pull requests, comments and sessions. */
Work service in Rust, with RFC 3339 timestamps502export interface WorkApi {
Issues and pull requests replace intents and attempts503 openIssue(actor: User, repo: RepoPath, input: OpenIssueInput): Promise<Result<Issue>>;
504 /** Newest first. */
505 listIssues(
506 repo: RepoPath,
507 viewer: Viewer,
508 filter?: { state?: State; label?: string },
509 ): Promise<Result<Issue[]>>;
510 getIssue(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<IssueDetail>>;
511 /** The author or a member of the workspace may. */
512 updateIssue(actor: User, repo: RepoPath, number: number, input: UpdateIssueInput): Promise<Result<Issue>>;
513 closeIssue(actor: User, repo: RepoPath, number: number, reason?: IssueReason): Promise<Result<Issue>>;
514 reopenIssue(actor: User, repo: RepoPath, number: number): Promise<Result<Issue>>;
515 /** The default labels, then every other label in use on the repository. */
516 listLabels(repo: RepoPath, viewer: Viewer): Promise<Result<string[]>>;
517 /** How many issues and pull requests are open. */
518 counts(repo: RepoPath, viewer: Viewer): Promise<Result<{ issues: number; pulls: number }>>;
Initial g1t: services, event bus, intents and attempts519
Acceptance checks in sandboxes, line comments and review verdicts520 /**
521 * On an issue or a pull request. On a pull request it may name a line of
522 * the change and carry a verdict; nobody can give a verdict on their own.
523 */
524 addComment(actor: User, repo: RepoPath, number: number, comment: NewComment): Promise<Result<Comment>>;
525
526 /**
527 * Begins a run of the acceptance checks for a pull request that is ready
528 * for review. For the runner service, which starts the sandbox.
529 */
530 startChecks(pullId: string): Promise<Result<CheckJob>>;
531 /**
532 * What a sandbox says about its run. With no results and no error it has
533 * started; `skip` forgets a run that will not be carried out.
534 */
535 reportChecks(runId: string, token: string, report: CheckReport): Promise<Result<CheckRun>>;
Agents as a team: lifecycle, merge queue, billing and a new shell536 /** Begins a review by a g1t agent. For the runner service. */
537 startReview(pullId: string): Promise<Result<ReviewJob>>;
538 /** Records that a review could not be written. For the runner service. */
539 failReview(runId: string, token: string, error: string): Promise<Result<boolean>>;
540
541 /**
542 * Works out the next step for a pull request g1t is seeing through and,
543 * if there is one to take now, claims it, so that it is taken once
544 * however often this is called. For the runner service.
545 */
546 advance(pullId: string): Promise<Advance>;
547 /** Records that a step could not be carried out, so a person is asked. */
548 stall(pullId: string, reason: string): Promise<boolean>;
549 /** Ids of the open pull requests g1t is seeing through. */
550 managedPulls(repoId?: string): Promise<string[]>;
Issues and pull requests replace intents and attempts551
Agents as a team: lifecycle, merge queue, billing and a new shell552 /** A repository's merge queue: what is in it, in order, and what recently left. */
553 queue(repo: RepoPath, viewer: Viewer): Promise<Result<QueueView>>;
Pull requests from branches554 /**
Agents as a team: lifecycle, merge queue, billing and a new shell555 * The next batch of combined states to test for a repository, one per
556 * entry; empty while a batch is being tested or nothing waits.
557 */
558 queueBuild(repoId: string): Promise<QueueJob[]>;
559 /** Reports that a combined state could not be built or checked. */
560 failQueue(entryId: string, token: string, error: string): Promise<Result<QueueState>>;
561 /** Takes a pull request out of the merge queue. Members only. */
562 removeFromQueue(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>;
563
564 getSettings(repo: RepoPath, viewer: Viewer): Promise<Result<RepoSettings>>;
565 /** Members of the repository's workspace only. */
566 updateSettings(actor: User, repo: RepoPath, settings: RepoSettingsInput): Promise<Result<RepoSettings>>;
567 /**
568 * What the runner needs to bring a pull request up to date because a
569 * merge of it was asked for. Null if none was.
570 */
571 catchUpJob(pullId: string): Promise<LifecycleJob | null>;
572
573 /**
Pull requests from branches574 * Opens a pull request: a draft with a fork to push to, or, given a
575 * branch, one ready for review.
576 */
Issues and pull requests replace intents and attempts577 openPull(actor: User, repo: RepoPath, input: OpenPullInput): Promise<Result<Pull>>;
578 /** Newest first. */
579 listPulls(repo: RepoPath, viewer: Viewer, state?: State): Promise<Result<Pull[]>>;
580 getPull(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<PullDetail>>;
Agents as a team: lifecycle, merge queue, billing and a new shell581 /**
582 * Changes who a pull request is assigned to and whose review is asked
583 * for; each list given replaces the whole set. Asking for `g1t-agent`'s
584 * review does not by itself start one: the runner's `review` does.
585 */
586 updatePull(
587 actor: User,
588 repo: RepoPath,
589 number: number,
590 changes: { assignees?: string[]; reviewers?: string[] },
591 ): Promise<Result<Pull>>;
Issues and pull requests replace intents and attempts592 /** Marks a draft ready for review and sets its description. */
593 readyPull(actor: User, repo: RepoPath, number: number, summary: string): Promise<Result<Pull>>;
594 closePull(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>;
Rust repos service with shipping; pull requests kept in the model595 /**
Issues and pull requests replace intents and attempts596 * Lands the pull request on the repository's default branch. Unless
597 * `keepIssueOpen`, that resolves the issue it was for: the issue closes
598 * naming this pull request, and the others still in progress for it close
599 * as superseded. Only members of the repository's workspace may merge.
Agents as a team: lifecycle, merge queue, billing and a new shell600 *
601 * If the default branch has moved, the pull request is brought up to date
602 * first and lands when that is done; it comes back still open, and
603 * `PullDetail.landing` is true meanwhile. A repository that requires pull
604 * requests to be up to date refuses instead.
Rust repos service with shipping; pull requests kept in the model605 */
Acceptance checks in sandboxes, line comments and review verdicts606 mergePull(
607 actor: User,
608 repo: RepoPath,
609 number: number,
610 options?: {
611 keepIssueOpen?: boolean;
612 /** Merge although the acceptance checks have not passed. */
613 ignoreChecks?: boolean;
614 },
615 ): Promise<Result<Pull>>;
Agents as a team: lifecycle, merge queue, billing and a new shell616 /**
617 * Drafts and open pull requests the viewer started, most recently active
618 * first, each with where it stands if g1t is seeing it through.
619 */
620 listActivePulls(
621 viewer: Viewer,
622 ): Promise<{ pull: Pull; issue: Issue | null; lifecycle: Lifecycle | null }[]>;
Initial g1t: services, event bus, intents and attempts623
Agents as a team: lifecycle, merge queue, billing and a new shell624 /**
625 * Records an outcome to plan for. Members only. For the runner service,
626 * which starts the sandbox in which an agent writes the plan.
627 */
628 startPlan(actor: User, repo: RepoPath, brief: string): Promise<Result<PlanJob>>;
629 /** Records that a plan could not be written. For the runner service. */
630 failPlan(planId: string, token: string, error: string): Promise<Result<boolean>>;
631 /** Members only. */
632 getPlan(repo: RepoPath, viewer: Viewer, id: string): Promise<Result<Plan>>;
633 /** Newest first. Members only. */
634 listPlans(repo: RepoPath, viewer: Viewer): Promise<Result<Plan[]>>;
635 /**
636 * Opens a plan's issues, each blocked by the ones it depends on. With
637 * `assign`, each is queued for a g1t agent. `keep` holds the positions,
638 * from 1, of the issues to open; all of them when absent. Once.
639 */
640 applyPlan(
641 actor: User,
642 repo: RepoPath,
643 id: string,
644 options?: { assign?: boolean; keep?: number[] },
645 ): Promise<Result<Plan>>;
646 /** Asks for a g1t agent to take an issue as soon as it can, or withdraws that. */
647 queueIssue(actor: User, repo: RepoPath, number: number, queued: boolean): Promise<Result<boolean>>;
648 /** Issues waiting for a g1t agent that can be given one now. For the runner. */
649 readyIssues(repoId?: string): Promise<ReadyIssue[]>;
650
651 /** Open issues assigned to the viewer, most recently changed first. */
652 listAssignedIssues(viewer: Viewer): Promise<Issue[]>;
653
Issues and pull requests replace intents and attempts654 appendSession(actor: User, repo: RepoPath, number: number, entries: NewSessionEntry[]): Promise<Result<{ count: number }>>;
655 readSession(repo: RepoPath, number: number, viewer: Viewer, afterSeq?: number): Promise<Result<SessionEntry[]>>;
Initial g1t: services, event bus, intents and attempts656}
Pull requests from branches657
658/**
659 * What to pass `ReposApi.compare` to see what a pull request changes.
660 *
661 * A fork is compared as a whole. A branch is compared by name while the
662 * pull request is open, and by the commit it was merged or closed at
663 * afterwards, so later pushes to the branch do not change the record.
664 */
665export function pullComparison(pull: Pull): {
666 repoId: string;
667 base: string | null;
668 head: string | null;
669} {
670 if (pull.forkRepoId) return { repoId: pull.forkRepoId, base: pull.mergeBase, head: null };
671 const settled = pull.status === "merged" || pull.status === "closed";
672 return {
673 repoId: pull.repoId,
674 base: pull.mergeBase,
675 head: (settled && pull.headCommit) || pull.branch,
676 };
677}
Agents as a team: lifecycle, merge queue, billing and a new shell678
679
680/** Where a pull request in a merge queue stands. */
681export type QueueState = "waiting" | "testing" | "passed" | "failed" | "landed" | "removed";
682
683/** One pull request's place in a merge queue. */
684export type QueueEntry = {
685 id: string;
686 number: number;
687 title: string;
688 agent: string;
689 state: QueueState;
690 /** The pull requests merged ahead of it in the state being tested, in order. */
691 ahead: number[];
692 baseCommit: string | null;
693 combinedCommit: string | null;
694 error: string | null;
695 results: CheckResult[];
696 /** Username of whoever merged it into the queue: a person, or `g1t`. */
697 enqueuedBy: string;
698 /** RFC 3339. */
699 createdAt: string;
700 /** RFC 3339. */
701 finishedAt: string | null;
702};
703
704/** A repository's merge queue: what is in it, in order, and what recently left. */
705export type QueueView = {
706 enabled: boolean;
707 active: QueueEntry[];
708 /** Newest first. */
709 recent: QueueEntry[];
710};
711
712export type QueueStackItem = {
713 number: number;
714 title: string;
715 /** The repository holding the change, and its branch. */
716 source: RepoPath;
717 branch: string;
718 commit: string;
719};
720
721/** What a sandbox needs to build and check one combined state. */
722export type QueueJob = {
723 entryId: string;
724 token: string;
725 repo: RepoPath;
726 defaultBranch: string;
727 baseCommit: string;
728 branch: string;
729 stack: QueueStackItem[];
730 checks: string[];
731 /** The checks of issues already completed: the default branch's contract. */
732 contractChecks: string[];
733 actor: User;
734};