Sign in

flagon-io/g1t

public

g1t/packages/contracts/src/work.ts

752 lines25,479 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;
Dark gray base with lavender as an accent, and a live outcome view for plans380 /** Once applied: where each issue it opened stands now, in plan order. */
381 progress: IssueProgress[];
Agents as a team: lifecycle, merge queue, billing and a new shell382};
383
384/** What a sandbox needs to write a plan. */
385export type PlanJob = {
386 planId: string;
387 /** Lets the sandbox, and nothing else, report this plan. */
388 token: string;
389 brief: string;
390 repo: RepoPath;
Issues and pull requests replace intents and attempts391};
Initial g1t: services, event bus, intents and attempts392
Agents as a team: lifecycle, merge queue, billing and a new shell393/** An issue waiting for a g1t agent that can be given one now. */
394export type ReadyIssue = {
395 repo: RepoPath;
396 number: number;
397 /** Who queued it, on whose say-so the agent works. */
398 actor: User;
399};
400
401/**
402 * How a repository wants its pull requests handled. A repository that has
403 * changed nothing has the defaults.
404 */
405export type RepoSettings = {
406 /**
407 * Land a g1t agent's pull request without a person once it is ready:
408 * checks passed and approved as the settings below require.
409 */
410 autoMerge: boolean;
411 /**
412 * Refuse to merge a pull request that does not contain the default
413 * branch's latest commits, so that what merges is what was checked. When
414 * off, merging one that is behind brings it up to date first.
415 */
416 requireUpToDate: boolean;
417 /**
418 * How many approving reviews a pull request needs before it may merge. A
419 * reviewer who has since asked for changes blocks it.
420 */
421 requiredApprovals: number;
422 /** Whether a g1t agent's approval counts towards `requiredApprovals`. */
423 countAgentApprovals: boolean;
424 /** Whether a member may merge although the acceptance checks did not pass. */
425 allowIgnoringChecks: boolean;
426 /** Whether a g1t agent's pull request is reviewed by a second agent unasked. */
427 agentReview: boolean;
428 /**
429 * How many times a g1t agent is sent back to its pull request before a
430 * person is asked instead.
431 */
432 maxRevisions: number;
433 /**
434 * Merge through a queue: pull requests are tested together with those
435 * ahead of them, and only a combination that passed reaches the default
436 * branch.
437 */
438 mergeQueue: boolean;
439 /** Username of the member who last changed the settings, if anyone has. */
440 updatedBy: string | null;
441 /** RFC 3339. */
442 updatedAt: string | null;
443};
444
445/** The settings a member can change. */
446export type RepoSettingsInput = Omit<RepoSettings, "updatedBy" | "updatedAt">;
447
448/** The next step for a pull request g1t is seeing through, already claimed. */
449export type Advance =
450 | { action: "none" }
451 | { action: "review" | "revise" | "catch_up"; job: LifecycleJob };
452
453/** What a sandbox needs to review a pull request. */
454export type ReviewJob = {
455 runId: string;
456 /** Lets the sandbox, and nothing else, report this review. */
457 token: string;
458 /** The repository holding the commit: the fork, or the repository itself. */
459 source: RepoPath;
460 commit: string;
461 repo: RepoPath;
462 defaultBranch: string;
463 number: number;
464 title: string;
465 description: string;
466 /** The issue the pull request is for, which says what it should achieve. */
467 issue: Issue | null;
468 /** Who opened the pull request, and so can read its source. */
469 author: User;
470};
471
Issues and pull requests replace intents and attempts472export type OpenIssueInput = {
473 title: string;
474 body: string;
475 labels?: string[];
476 checks?: string[];
477};
478
Agents as a team: lifecycle, merge queue, billing and a new shell479export type UpdateIssueInput = {
480 title?: string;
481 body?: string;
482 labels?: string[];
483 /** Usernames of the people it is assigned to; replaces the whole set. */
484 assignees?: string[];
485};
Issues and pull requests replace intents and attempts486
487export type OpenPullInput = {
488 /** The number of the issue this is for. */
489 issue?: number;
490 /** Defaults to the issue's title; required without an issue. */
491 title?: string;
Pull requests from branches492 /** What changed and why. Usually set later, when a draft is marked ready. */
493 body?: string;
494 /**
495 * A branch of the repository that already holds the change. The pull
496 * request is then ready for review at once and has no fork.
497 */
498 branch?: string;
Issues and pull requests replace intents and attempts499 agent: string;
500 runtime: Runtime;
501};
Initial g1t: services, event bus, intents and attempts502
Issues and pull requests replace intents and attempts503/** Issues, pull requests, comments and sessions. */
Work service in Rust, with RFC 3339 timestamps504export interface WorkApi {
Issues and pull requests replace intents and attempts505 openIssue(actor: User, repo: RepoPath, input: OpenIssueInput): Promise<Result<Issue>>;
506 /** Newest first. */
507 listIssues(
508 repo: RepoPath,
509 viewer: Viewer,
510 filter?: { state?: State; label?: string },
511 ): Promise<Result<Issue[]>>;
512 getIssue(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<IssueDetail>>;
513 /** The author or a member of the workspace may. */
514 updateIssue(actor: User, repo: RepoPath, number: number, input: UpdateIssueInput): Promise<Result<Issue>>;
515 closeIssue(actor: User, repo: RepoPath, number: number, reason?: IssueReason): Promise<Result<Issue>>;
516 reopenIssue(actor: User, repo: RepoPath, number: number): Promise<Result<Issue>>;
517 /** The default labels, then every other label in use on the repository. */
518 listLabels(repo: RepoPath, viewer: Viewer): Promise<Result<string[]>>;
519 /** How many issues and pull requests are open. */
520 counts(repo: RepoPath, viewer: Viewer): Promise<Result<{ issues: number; pulls: number }>>;
Initial g1t: services, event bus, intents and attempts521
Acceptance checks in sandboxes, line comments and review verdicts522 /**
523 * On an issue or a pull request. On a pull request it may name a line of
524 * the change and carry a verdict; nobody can give a verdict on their own.
525 */
526 addComment(actor: User, repo: RepoPath, number: number, comment: NewComment): Promise<Result<Comment>>;
527
528 /**
529 * Begins a run of the acceptance checks for a pull request that is ready
530 * for review. For the runner service, which starts the sandbox.
531 */
532 startChecks(pullId: string): Promise<Result<CheckJob>>;
533 /**
534 * What a sandbox says about its run. With no results and no error it has
535 * started; `skip` forgets a run that will not be carried out.
536 */
537 reportChecks(runId: string, token: string, report: CheckReport): Promise<Result<CheckRun>>;
Agents as a team: lifecycle, merge queue, billing and a new shell538 /** Begins a review by a g1t agent. For the runner service. */
539 startReview(pullId: string): Promise<Result<ReviewJob>>;
540 /** Records that a review could not be written. For the runner service. */
541 failReview(runId: string, token: string, error: string): Promise<Result<boolean>>;
542
543 /**
544 * Works out the next step for a pull request g1t is seeing through and,
545 * if there is one to take now, claims it, so that it is taken once
546 * however often this is called. For the runner service.
547 */
548 advance(pullId: string): Promise<Advance>;
549 /** Records that a step could not be carried out, so a person is asked. */
550 stall(pullId: string, reason: string): Promise<boolean>;
551 /** Ids of the open pull requests g1t is seeing through. */
552 managedPulls(repoId?: string): Promise<string[]>;
Issues and pull requests replace intents and attempts553
Agents as a team: lifecycle, merge queue, billing and a new shell554 /** A repository's merge queue: what is in it, in order, and what recently left. */
555 queue(repo: RepoPath, viewer: Viewer): Promise<Result<QueueView>>;
Pull requests from branches556 /**
Agents as a team: lifecycle, merge queue, billing and a new shell557 * The next batch of combined states to test for a repository, one per
558 * entry; empty while a batch is being tested or nothing waits.
559 */
560 queueBuild(repoId: string): Promise<QueueJob[]>;
561 /** Reports that a combined state could not be built or checked. */
562 failQueue(entryId: string, token: string, error: string): Promise<Result<QueueState>>;
563 /** Takes a pull request out of the merge queue. Members only. */
564 removeFromQueue(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>;
565
566 getSettings(repo: RepoPath, viewer: Viewer): Promise<Result<RepoSettings>>;
567 /** Members of the repository's workspace only. */
568 updateSettings(actor: User, repo: RepoPath, settings: RepoSettingsInput): Promise<Result<RepoSettings>>;
569 /**
570 * What the runner needs to bring a pull request up to date because a
571 * merge of it was asked for. Null if none was.
572 */
573 catchUpJob(pullId: string): Promise<LifecycleJob | null>;
574
575 /**
Pull requests from branches576 * Opens a pull request: a draft with a fork to push to, or, given a
577 * branch, one ready for review.
578 */
Issues and pull requests replace intents and attempts579 openPull(actor: User, repo: RepoPath, input: OpenPullInput): Promise<Result<Pull>>;
580 /** Newest first. */
581 listPulls(repo: RepoPath, viewer: Viewer, state?: State): Promise<Result<Pull[]>>;
582 getPull(repo: RepoPath, number: number, viewer: Viewer): Promise<Result<PullDetail>>;
Agents as a team: lifecycle, merge queue, billing and a new shell583 /**
584 * Changes who a pull request is assigned to and whose review is asked
585 * for; each list given replaces the whole set. Asking for `g1t-agent`'s
586 * review does not by itself start one: the runner's `review` does.
587 */
588 updatePull(
589 actor: User,
590 repo: RepoPath,
591 number: number,
592 changes: { assignees?: string[]; reviewers?: string[] },
593 ): Promise<Result<Pull>>;
Issues and pull requests replace intents and attempts594 /** Marks a draft ready for review and sets its description. */
595 readyPull(actor: User, repo: RepoPath, number: number, summary: string): Promise<Result<Pull>>;
596 closePull(actor: User, repo: RepoPath, number: number): Promise<Result<Pull>>;
Rust repos service with shipping; pull requests kept in the model597 /**
Issues and pull requests replace intents and attempts598 * Lands the pull request on the repository's default branch. Unless
599 * `keepIssueOpen`, that resolves the issue it was for: the issue closes
600 * naming this pull request, and the others still in progress for it close
601 * as superseded. Only members of the repository's workspace may merge.
Agents as a team: lifecycle, merge queue, billing and a new shell602 *
603 * If the default branch has moved, the pull request is brought up to date
604 * first and lands when that is done; it comes back still open, and
605 * `PullDetail.landing` is true meanwhile. A repository that requires pull
606 * requests to be up to date refuses instead.
Rust repos service with shipping; pull requests kept in the model607 */
Acceptance checks in sandboxes, line comments and review verdicts608 mergePull(
609 actor: User,
610 repo: RepoPath,
611 number: number,
612 options?: {
613 keepIssueOpen?: boolean;
614 /** Merge although the acceptance checks have not passed. */
615 ignoreChecks?: boolean;
616 },
617 ): Promise<Result<Pull>>;
Agents as a team: lifecycle, merge queue, billing and a new shell618 /**
619 * Drafts and open pull requests the viewer started, most recently active
620 * first, each with where it stands if g1t is seeing it through.
621 */
622 listActivePulls(
623 viewer: Viewer,
624 ): Promise<{ pull: Pull; issue: Issue | null; lifecycle: Lifecycle | null }[]>;
Initial g1t: services, event bus, intents and attempts625
Agents as a team: lifecycle, merge queue, billing and a new shell626 /**
627 * Records an outcome to plan for. Members only. For the runner service,
628 * which starts the sandbox in which an agent writes the plan.
629 */
630 startPlan(actor: User, repo: RepoPath, brief: string): Promise<Result<PlanJob>>;
631 /** Records that a plan could not be written. For the runner service. */
632 failPlan(planId: string, token: string, error: string): Promise<Result<boolean>>;
633 /** Members only. */
634 getPlan(repo: RepoPath, viewer: Viewer, id: string): Promise<Result<Plan>>;
635 /** Newest first. Members only. */
636 listPlans(repo: RepoPath, viewer: Viewer): Promise<Result<Plan[]>>;
637 /**
638 * Opens a plan's issues, each blocked by the ones it depends on. With
639 * `assign`, each is queued for a g1t agent. `keep` holds the positions,
640 * from 1, of the issues to open; all of them when absent. Once.
641 */
642 applyPlan(
643 actor: User,
644 repo: RepoPath,
645 id: string,
646 options?: { assign?: boolean; keep?: number[] },
647 ): Promise<Result<Plan>>;
648 /** Asks for a g1t agent to take an issue as soon as it can, or withdraws that. */
649 queueIssue(actor: User, repo: RepoPath, number: number, queued: boolean): Promise<Result<boolean>>;
650 /** Issues waiting for a g1t agent that can be given one now. For the runner. */
651 readyIssues(repoId?: string): Promise<ReadyIssue[]>;
652
653 /** Open issues assigned to the viewer, most recently changed first. */
654 listAssignedIssues(viewer: Viewer): Promise<Issue[]>;
655
Issues and pull requests replace intents and attempts656 appendSession(actor: User, repo: RepoPath, number: number, entries: NewSessionEntry[]): Promise<Result<{ count: number }>>;
657 readSession(repo: RepoPath, number: number, viewer: Viewer, afterSeq?: number): Promise<Result<SessionEntry[]>>;
Initial g1t: services, event bus, intents and attempts658}
Pull requests from branches659
660/**
661 * What to pass `ReposApi.compare` to see what a pull request changes.
662 *
663 * A fork is compared as a whole. A branch is compared by name while the
664 * pull request is open, and by the commit it was merged or closed at
665 * afterwards, so later pushes to the branch do not change the record.
666 */
667export function pullComparison(pull: Pull): {
668 repoId: string;
669 base: string | null;
670 head: string | null;
671} {
672 if (pull.forkRepoId) return { repoId: pull.forkRepoId, base: pull.mergeBase, head: null };
673 const settled = pull.status === "merged" || pull.status === "closed";
674 return {
675 repoId: pull.repoId,
676 base: pull.mergeBase,
677 head: (settled && pull.headCommit) || pull.branch,
678 };
679}
Agents as a team: lifecycle, merge queue, billing and a new shell680
681
682/** Where a pull request in a merge queue stands. */
Dark gray base with lavender as an accent, and a live outcome view for plans683/** Where one issue of an applied plan stands. */
684export type IssueProgress = {
685 number: number;
686 title: string;
687 /**
688 * `blocked`, `waiting` (for an agent), `open`, a lifecycle stage,
689 * `landed` or `closed`.
690 */
691 state: string;
692 detail: string;
693 /** The issues it is waiting on that are still open. */
694 blockedBy: number[];
695 pull: number | null;
696 agent: string | null;
697};
698
Agents as a team: lifecycle, merge queue, billing and a new shell699export type QueueState = "waiting" | "testing" | "passed" | "failed" | "landed" | "removed";
700
701/** One pull request's place in a merge queue. */
702export type QueueEntry = {
703 id: string;
704 number: number;
705 title: string;
706 agent: string;
707 state: QueueState;
708 /** The pull requests merged ahead of it in the state being tested, in order. */
709 ahead: number[];
710 baseCommit: string | null;
711 combinedCommit: string | null;
712 error: string | null;
713 results: CheckResult[];
714 /** Username of whoever merged it into the queue: a person, or `g1t`. */
715 enqueuedBy: string;
716 /** RFC 3339. */
717 createdAt: string;
718 /** RFC 3339. */
719 finishedAt: string | null;
720};
721
722/** A repository's merge queue: what is in it, in order, and what recently left. */
723export type QueueView = {
724 enabled: boolean;
725 active: QueueEntry[];
726 /** Newest first. */
727 recent: QueueEntry[];
728};
729
730export type QueueStackItem = {
731 number: number;
732 title: string;
733 /** The repository holding the change, and its branch. */
734 source: RepoPath;
735 branch: string;
736 commit: string;
737};
738
739/** What a sandbox needs to build and check one combined state. */
740export type QueueJob = {
741 entryId: string;
742 token: string;
743 repo: RepoPath;
744 defaultBranch: string;
745 baseCommit: string;
746 branch: string;
747 stack: QueueStackItem[];
748 checks: string[];
749 /** The checks of issues already completed: the default branch's contract. */
750 contractChecks: string[];
751 actor: User;
752};