@procedures/gh 0.0.0-stage → 0.3.0

package/dist/procedures/gh/run/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../src/procedures/gh/run/list.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEjE,MAAM,MAAM,GAAG,yGAAyG,CAAC;AAEzH;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,KAAqB,EAAE,GAAqB;IAC1E,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9G,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7F,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrF,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrF,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAiC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AACnF,CAAC"}

package/dist/procedures/gh/run/rerun.d.ts

@@ -0,0 +1,12 @@
+/**
+ * gh.run.rerun procedure
+ *
+ * Run a workflow run again
+ */
+import type { ProcedureContext } from "@procedures/client";
+import type { GhRunRerunInput, GhRunRerunOutput } from "../../../types.js";
+/**
+ * Run a workflow run again
+ */
+export declare function ghRunRerun(input: GhRunRerunInput, ctx: ProcedureContext): Promise<GhRunRerunOutput>;
+//# sourceMappingURL=rerun.d.ts.map

package/dist/procedures/gh/run/rerun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rerun.d.ts","sourceRoot":"","sources":["../../../../src/procedures/gh/run/rerun.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAG3E;;GAEG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAKzG"}

package/dist/procedures/gh/run/rerun.js

@@ -0,0 +1,17 @@
+/**
+ * gh.run.rerun procedure
+ *
+ * Run a workflow run again
+ */
+import { repoArgs, runGh } from "../shared.js";
+/**
+ * Run a workflow run again
+ */
+export async function ghRunRerun(input, ctx) {
+    const args = ["run", "rerun", String(input.run), ...repoArgs(input)];
+    if (input.failedOnly)
+        args.push("--failed");
+    await runGh(args, input, ctx);
+    return { run: input.run };
+}
+//# sourceMappingURL=rerun.js.map

package/dist/procedures/gh/run/rerun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rerun.js","sourceRoot":"","sources":["../../../../src/procedures/gh/run/rerun.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,KAAsB,EAAE,GAAqB;IAC5E,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACrE,IAAI,KAAK,CAAC,UAAU;QAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9B,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;AAC5B,CAAC"}

package/dist/procedures/gh/run/view.d.ts

@@ -0,0 +1,12 @@
+/**
+ * gh.run.view procedure
+ *
+ * One workflow run with its jobs
+ */
+import type { ProcedureContext } from "@procedures/client";
+import type { GhRunViewInput, GhRunViewOutput } from "../../../types.js";
+/**
+ * One workflow run with its jobs
+ */
+export declare function ghRunView(input: GhRunViewInput, ctx: ProcedureContext): Promise<GhRunViewOutput>;
+//# sourceMappingURL=view.d.ts.map

package/dist/procedures/gh/run/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../../../src/procedures/gh/run/view.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKzE;;GAEG;AACH,wBAAsB,SAAS,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CAGtG"}

package/dist/procedures/gh/run/view.js

@@ -0,0 +1,15 @@
+/**
+ * gh.run.view procedure
+ *
+ * One workflow run with its jobs
+ */
+import { ghJson, repoArgs } from "../shared.js";
+const FIELDS = "databaseId,workflowName,displayTitle,headBranch,headSha,event,status,conclusion,url,createdAt,updatedAt,jobs";
+/**
+ * One workflow run with its jobs
+ */
+export async function ghRunView(input, ctx) {
+    const args = ["run", "view", String(input.run), "--json", FIELDS, ...repoArgs(input)];
+    return { item: await ghJson(args, input, ctx) };
+}
+//# sourceMappingURL=view.js.map

package/dist/procedures/gh/run/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/procedures/gh/run/view.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,MAAM,GAAG,8GAA8G,CAAC;AAE9H;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,KAAqB,EAAE,GAAqB;IAC1E,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACtF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAA0B,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3E,CAAC"}

package/dist/procedures/gh/shared.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The way every gh procedure runs the GitHub CLI: an argument list through `shell.run`, no
+ * shell. A value that gh reads as an argument must not start with "-", so it cannot become an
+ * option. The output is the JSON of `--json` where gh has it.
+ */
+import type { ProcedureContext } from "@procedures/client";
+import type { GhCommonInput } from "../../types.js";
+/** A failed gh command: its exit code and its error text. */
+export declare class GhError extends Error {
+    readonly exitCode: number;
+    readonly stderr: string;
+    readonly name = "GhError";
+    constructor(message: string, exitCode: number, stderr: string);
+}
+/** A value that gh reads as an argument (a branch, a tag, a title): it must not start with "-". */
+export declare function ghArg(name: string, value: string): string;
+/** The option `--repo owner/name`, when the input gives a repository. */
+export declare function repoArgs(input: GhCommonInput): string[];
+/** This function runs `gh <args>` and gives its output. It throws a GhError for a failed command. */
+export declare function runGh(args: string[], input: GhCommonInput, ctx: ProcedureContext): Promise<string>;
+/** This function runs gh with `--json` and gives the parsed value. */
+export declare function ghJson<T>(args: string[], input: GhCommonInput, ctx: ProcedureContext): Promise<T>;
+/** The options of a list: its limit and a search. */
+export declare function listArgs(input: {
+    limit?: number | undefined;
+    search?: string | undefined;
+}): string[];
+/** The last line of an output that is a URL: gh prints the URL of what it made. */
+export declare function urlOf(output: string): string;
+//# sourceMappingURL=shared.d.ts.map

package/dist/procedures/gh/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/procedures/gh/shared.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAUpD,6DAA6D;AAC7D,qBAAa,OAAQ,SAAQ,KAAK;IAI9B,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAJzB,SAAkB,IAAI,aAAa;IACnC,YACE,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EAGxB;CACF;AAED,mGAAmG;AACnG,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGzD;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,CAEvD;AAED,qGAAqG;AACrG,wBAAsB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAUxG;AAED,sEAAsE;AACtE,wBAAsB,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,CAOvG;AAED,qDAAqD;AACrD,wBAAgB,QAAQ,CAAC,KAAK,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,MAAM,EAAE,CAIrG;AAED,mFAAmF;AACnF,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5C"}

package/dist/procedures/gh/shared.js

@@ -0,0 +1,63 @@
+/**
+ * The way every gh procedure runs the GitHub CLI: an argument list through `shell.run`, no
+ * shell. A value that gh reads as an argument must not start with "-", so it cannot become an
+ * option. The output is the JSON of `--json` where gh has it.
+ */
+/** A failed gh command: its exit code and its error text. */
+export class GhError extends Error {
+    exitCode;
+    stderr;
+    name = "GhError";
+    constructor(message, exitCode, stderr) {
+        super(message);
+        this.exitCode = exitCode;
+        this.stderr = stderr;
+    }
+}
+/** A value that gh reads as an argument (a branch, a tag, a title): it must not start with "-". */
+export function ghArg(name, value) {
+    if (value.startsWith("-"))
+        throw new Error(`Invalid ${name} (starts with "-"): ${value}`);
+    return value;
+}
+/** The option `--repo owner/name`, when the input gives a repository. */
+export function repoArgs(input) {
+    return input.repo === undefined ? [] : ["--repo", ghArg("repo", input.repo)];
+}
+/** This function runs `gh <args>` and gives its output. It throws a GhError for a failed command. */
+export async function runGh(args, input, ctx) {
+    const shellInput = { command: "gh", args };
+    if (input.cwd !== undefined)
+        shellInput.cwd = input.cwd;
+    if (input.timeoutMs !== undefined)
+        shellInput.timeout = input.timeoutMs;
+    const result = await ctx.client.call(["shell", "run"], shellInput);
+    if (result.exitCode !== 0) {
+        const text = result.stderr.trim() || result.stdout.trim();
+        throw new GhError(`gh ${args[0] ?? ""} ${args[1] ?? ""} failed (exit ${result.exitCode}): ${text}`.trim(), result.exitCode, result.stderr);
+    }
+    return result.stdout;
+}
+/** This function runs gh with `--json` and gives the parsed value. */
+export async function ghJson(args, input, ctx) {
+    const output = await runGh(args, input, ctx);
+    try {
+        return JSON.parse(output);
+    }
+    catch {
+        throw new GhError(`gh ${args[0] ?? ""} ${args[1] ?? ""} gave no JSON: ${output.slice(0, 200)}`, 0, "");
+    }
+}
+/** The options of a list: its limit and a search. */
+export function listArgs(input) {
+    const args = ["--limit", String(input.limit ?? 30)];
+    if (input.search !== undefined)
+        args.push("--search", input.search);
+    return args;
+}
+/** The last line of an output that is a URL: gh prints the URL of what it made. */
+export function urlOf(output) {
+    const lines = output.trim().split(/\r?\n/);
+    return lines.reverse().find((line) => line.startsWith("https://")) ?? lines[0] ?? "";
+}
+//# sourceMappingURL=shared.js.map

package/dist/procedures/gh/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../src/procedures/gh/shared.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAaH,6DAA6D;AAC7D,MAAM,OAAO,OAAQ,SAAQ,KAAK;IAIrB,QAAQ;IACR,MAAM;IAJC,IAAI,GAAG,SAAS,CAAC;IACnC,YACE,OAAe,EACN,QAAgB,EAChB,MAAc;QAEvB,KAAK,CAAC,OAAO,CAAC,CAAC;wBAHN,QAAQ;sBACR,MAAM;IAGjB,CAAC;CACF;AAED,mGAAmG;AACnG,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,KAAa;IAC/C,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,uBAAuB,KAAK,EAAE,CAAC,CAAC;IAC1F,OAAO,KAAK,CAAC;AACf,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,IAAc,EAAE,KAAoB,EAAE,GAAqB;IACrF,MAAM,UAAU,GAAkB,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC1D,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS;QAAE,UAAU,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IACxD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS;QAAE,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC;IACxE,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAsE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IACxI,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,MAAM,CAAC,QAAQ,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7I,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED,sEAAsE;AACtE,MAAM,CAAC,KAAK,UAAU,MAAM,CAAI,IAAc,EAAE,KAAoB,EAAE,GAAqB;IACzF,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAM,CAAC;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACzG,CAAC;AACH,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,QAAQ,CAAC,KAAkE;IACzF,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;IACpD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,KAAK,CAAC,MAAc;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACvF,CAAC"}

package/dist/register.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Importing this file registers the procedures of @procedures/gh in the global registry:
+ * `import "@procedures/gh/register"`. The package root registers nothing.
+ */
+export * from "./module.js";
+//# sourceMappingURL=register.d.ts.map

package/dist/register.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,cAAc,aAAa,CAAC"}

package/dist/register.js

@@ -0,0 +1,8 @@
+/**
+ * Importing this file registers the procedures of @procedures/gh in the global registry:
+ * `import "@procedures/gh/register"`. The package root registers nothing.
+ */
+import { registerGhProcedures } from "./module.js";
+export * from "./module.js";
+registerGhProcedures();
+//# sourceMappingURL=register.js.map

package/dist/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,cAAc,aAAa,CAAC;AAE5B,oBAAoB,EAAE,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Type definitions of the procedures of this package
+ *
+ * mark procedure new adds the types of each new procedure here. The zod schemas are in
+ * `module.ts`: an exported schema needs a written type (isolatedDeclarations).
+ */
+/** The fields of each gh procedure. */
+export interface GhCommonInput {
+    /** The repository as owner/name (default: the repository of the folder) */
+    repo?: string | undefined;
+    /** The folder where gh runs */
+    cwd?: string | undefined;
+    /** The time limit of the command, in milliseconds */
+    timeoutMs?: number | undefined;
+}
+/** A list of the JSON objects that gh gives. */
+export interface GhListOutput {
+    items: Array<Record<string, unknown>>;
+}
+/** One JSON object that gh gives. */
+export interface GhItemOutput {
+    item: Record<string, unknown>;
+}
+/** What gh made: its URL. */
+export interface GhCreatedOutput {
+    url: string;
+}
+export interface GhPrListInput extends GhCommonInput {
+    state?: "open" | "closed" | "merged" | "all" | undefined;
+    author?: string | undefined;
+    base?: string | undefined;
+    head?: string | undefined;
+    search?: string | undefined;
+    limit?: number | undefined;
+}
+export type GhPrListOutput = GhListOutput;
+export interface GhPrViewInput extends GhCommonInput {
+    /** The number, the branch or the URL of the pull request */
+    pr: string;
+}
+export type GhPrViewOutput = GhItemOutput;
+export interface GhPrChecksInput extends GhCommonInput {
+    pr: string;
+}
+export type GhPrChecksOutput = GhListOutput;
+export interface GhPrCreateInput extends GhCommonInput {
+    title: string;
+    body: string;
+    base?: string | undefined;
+    head?: string | undefined;
+    draft?: boolean | undefined;
+}
+export type GhPrCreateOutput = GhCreatedOutput;
+export interface GhRunListInput extends GhCommonInput {
+    workflow?: string | undefined;
+    branch?: string | undefined;
+    status?: string | undefined;
+    limit?: number | undefined;
+}
+export type GhRunListOutput = GhListOutput;
+export interface GhRunViewInput extends GhCommonInput {
+    /** The id of the run */
+    run: number;
+}
+export type GhRunViewOutput = GhItemOutput;
+export interface GhRunRerunInput extends GhCommonInput {
+    run: number;
+    /** Only the jobs that failed */
+    failedOnly?: boolean | undefined;
+}
+export interface GhRunRerunOutput {
+    run: number;
+}
+export interface GhReleaseListInput extends GhCommonInput {
+    limit?: number | undefined;
+}
+export type GhReleaseListOutput = GhListOutput;
+export interface GhReleaseViewInput extends GhCommonInput {
+    /** The tag of the release (default: the latest release) */
+    tag?: string | undefined;
+}
+export type GhReleaseViewOutput = GhItemOutput;
+export interface GhIssueListInput extends GhCommonInput {
+    state?: "open" | "closed" | "all" | undefined;
+    label?: string | undefined;
+    author?: string | undefined;
+    search?: string | undefined;
+    limit?: number | undefined;
+}
+export type GhIssueListOutput = GhListOutput;
+export interface GhIssueViewInput extends GhCommonInput {
+    /** The number or the URL of the issue */
+    issue: string;
+}
+export type GhIssueViewOutput = GhItemOutput;
+export interface GhIssueCreateInput extends GhCommonInput {
+    title: string;
+    body: string;
+    labels?: string[] | undefined;
+}
+export type GhIssueCreateOutput = GhCreatedOutput;
+export interface GhIssueCommentInput extends GhCommonInput {
+    /** The number or the URL of the issue or the pull request */
+    issue: string;
+    body: string;
+}
+export type GhIssueCommentOutput = GhCreatedOutput;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,uCAAuC;AACvC,MAAM,WAAW,aAAa;IAC5B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,+BAA+B;IAC/B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACvC;AAED,qCAAqC;AACrC,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,6BAA6B;AAC7B,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AACD,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC;AAE1C,MAAM,WAAW,aAAc,SAAQ,aAAa;IAClD,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;CACZ;AACD,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC;AAE1C,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,EAAE,EAAE,MAAM,CAAC;CACZ;AACD,MAAM,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAE5C,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7B;AACD,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAE/C,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AACD,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC;AAE3C,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,wBAAwB;IACxB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC;AAE3C,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAClC;AACD,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AACD,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAE/C,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AACD,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAE/C,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;IAC9C,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AACD,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAE7C,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;CACf;AACD,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAE7C,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC/B;AACD,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAElD,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AACD,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAAC"}

package/dist/types.js

@@ -0,0 +1,8 @@
+/**
+ * Type definitions of the procedures of this package
+ *
+ * mark procedure new adds the types of each new procedure here. The zod schemas are in
+ * `module.ts`: an exported schema needs a written type (isolatedDeclarations).
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/package.json

@@ -1,6 +1,81 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@procedures/gh",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.3.0",
+  "description": "The GitHub CLI as procedures: pull requests, workflow runs, releases and issues, with an argument list and no shell.",
+  "keywords": [
+    "procedures",
+    "github",
+    "gh",
+    "pull-requests",
+    "workflows",
+    "releases",
+    "issues"
+  ],
+  "homepage": "https://mark1russell7.github.io/client/",
+  "bugs": {
+    "url": "https://github.com/mark1russell7/client/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mark1russell7/client.git",
+    "directory": "packages/gh"
+  },
+  "license": "MIT",
+  "author": "Mark Russell (https://github.com/mark1russell7)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./module": {
+      "types": "./dist/module.d.ts",
+      "import": "./dist/module.js"
+    },
+    "./register": {
+      "types": "./dist/register.d.ts",
+      "import": "./dist/register.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/**/__tests__",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": [
+    "./dist/register.js"
+  ],
+  "devDependencies": {
+    "@mark1russell7/cue": "^1.0.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.3"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "client": {
+    "procedures": "./dist/register.js"
+  },
+  "dependencies": {
+    "@procedures/client": "0.3.0",
+    "@procedures/shell": "0.3.0",
+    "zod": "^4.6.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist .tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
 }

package/src/index.ts

@@ -0,0 +1,3 @@
+// The root registers nothing: import "<package>/register", or give the module to createRegistry()
+export * from "./module.js";
+export * from "./types.js";

package/src/module.ts

@@ -0,0 +1,167 @@
+/**
+ * The procedures of @procedures/gh as data. Importing this file registers nothing.
+ *
+ * Each procedure runs the GitHub CLI (`gh`) through `shell.run`, with an argument list and no
+ * shell (roadmap R42). The reads declare `reads: ["network"]`. The procedures that make or change
+ * something on GitHub declare `writes: ["network"]`.
+ *
+ * Scaffold a procedure with: mark procedure new <name> --path packages/gh
+ */
+
+import { z } from "zod";
+import { defineModule, registerModules, PROCEDURE_REGISTRY, type AnyProcedure, type Effects, type ProcedureModule, type ProcedureRegistry, createProcedure, zodAdapter } from "@procedures/client";
+import shellModule from "@procedures/shell/module";
+import { ghPrList } from "./procedures/gh/pr/list.js";
+import { ghPrView } from "./procedures/gh/pr/view.js";
+import { ghPrChecks } from "./procedures/gh/pr/checks.js";
+import { ghPrCreate } from "./procedures/gh/pr/create.js";
+import { ghRunList } from "./procedures/gh/run/list.js";
+import { ghRunView } from "./procedures/gh/run/view.js";
+import { ghRunRerun } from "./procedures/gh/run/rerun.js";
+import { ghReleaseList } from "./procedures/gh/release/list.js";
+import { ghReleaseView } from "./procedures/gh/release/view.js";
+import { ghIssueList } from "./procedures/gh/issue/list.js";
+import { ghIssueView } from "./procedures/gh/issue/view.js";
+import { ghIssueCreate } from "./procedures/gh/issue/create.js";
+import { ghIssueComment } from "./procedures/gh/issue/comment.js";
+
+/** A read of GitHub: it changes nothing. */
+const READS: Effects = { reads: ["network"], writes: [] };
+/** A write to GitHub that makes something new: not destructive, and a second call makes a second one. */
+const MAKES: Effects = { reads: ["network"], writes: ["network"], destructive: false, idempotent: false };
+
+const common = {
+  repo: z.string().regex(/^[\w.-]+\/[\w.-]+$/, "owner/name").optional().describe("The repository as owner/name (default: the repository of the folder)"),
+  cwd: z.string().optional().describe("The folder where gh runs"),
+  timeoutMs: z.number().int().min(1).optional().describe("The time limit of the command, in milliseconds"),
+};
+const limit = z.number().int().min(1).max(1000).optional().describe("The most items (default 30)");
+const list = z.object({ items: z.array(z.record(z.string(), z.unknown())).describe("The JSON objects that gh gives") });
+const item = z.object({ item: z.record(z.string(), z.unknown()).describe("The JSON object that gh gives") });
+const created = z.object({ url: z.string().describe("The URL of what gh made") });
+
+/** One procedure of this package. Each one runs gh through shell.run, and declares it. */
+function gh<I, O>(
+  path: string[],
+  description: string,
+  input: z.ZodType<I>,
+  output: z.ZodType<O>,
+  effects: Effects,
+  handler: (input: I, ctx: Parameters<typeof ghPrList>[1]) => Promise<O>,
+  args: string[] = [],
+): AnyProcedure {
+  return createProcedure()
+    .path(path)
+    .input(zodAdapter<I>(input))
+    .output(zodAdapter<O>(output))
+    .meta({ description, args, shorts: {}, output: "json", effects, calls: ["shell.run"] })
+    .handler(handler as never)
+    .build() as unknown as AnyProcedure;
+}
+
+const procedures: AnyProcedure[] = [
+  gh(
+    ["gh", "pr", "list"],
+    "The pull requests of a repository",
+    z.object({
+      ...common,
+      state: z.enum(["open", "closed", "merged", "all"]).optional().describe("The state (default open)"),
+      author: z.string().optional().describe("Only the pull requests of this author"),
+      base: z.string().optional().describe("Only the pull requests into this branch"),
+      head: z.string().optional().describe("Only the pull requests from this branch"),
+      search: z.string().optional().describe("A search of GitHub"),
+      limit,
+    }),
+    list,
+    READS,
+    ghPrList,
+  ),
+  gh(["gh", "pr", "view"], "One pull request", z.object({ ...common, pr: z.string().min(1).describe("The number, the branch or the URL of the pull request") }), item, READS, ghPrView, ["pr"]),
+  gh(["gh", "pr", "checks"], "The checks of a pull request", z.object({ ...common, pr: z.string().min(1).describe("The number, the branch or the URL of the pull request") }), list, READS, ghPrChecks, ["pr"]),
+  gh(
+    ["gh", "pr", "create"],
+    "Open a pull request",
+    z.object({
+      ...common,
+      title: z.string().min(1).describe("The title"),
+      body: z.string().describe("The text of the pull request"),
+      base: z.string().optional().describe("The branch to merge into (default: the default branch)"),
+      head: z.string().optional().describe("The branch with the changes (default: the current branch)"),
+      draft: z.boolean().optional().describe("Open it as a draft"),
+    }),
+    created,
+    MAKES,
+    ghPrCreate,
+  ),
+  gh(
+    ["gh", "run", "list"],
+    "The workflow runs of a repository",
+    z.object({
+      ...common,
+      workflow: z.string().optional().describe("The name or the file of a workflow"),
+      branch: z.string().optional().describe("Only the runs of this branch"),
+      status: z.string().optional().describe("Only the runs with this status, for example completed or failure"),
+      limit: z.number().int().min(1).max(1000).optional().describe("The most runs (default 20)"),
+    }),
+    list,
+    READS,
+    ghRunList,
+  ),
+  gh(["gh", "run", "view"], "One workflow run with its jobs", z.object({ ...common, run: z.number().int().min(1).describe("The id of the run") }), item, READS, ghRunView, ["run"]),
+  gh(
+    ["gh", "run", "rerun"],
+    "Run a workflow run again",
+    z.object({ ...common, run: z.number().int().min(1).describe("The id of the run"), failedOnly: z.boolean().optional().describe("Only the jobs that failed") }),
+    z.object({ run: z.number().describe("The id of the run") }),
+    MAKES,
+    ghRunRerun,
+    ["run"],
+  ),
+  gh(["gh", "release", "list"], "The releases of a repository", z.object({ ...common, limit }), list, READS, ghReleaseList),
+  gh(["gh", "release", "view"], "One release: the release of a tag, or the latest release", z.object({ ...common, tag: z.string().optional().describe("The tag (default: the latest release)") }), item, READS, ghReleaseView, ["tag"]),
+  gh(
+    ["gh", "issue", "list"],
+    "The issues of a repository",
+    z.object({
+      ...common,
+      state: z.enum(["open", "closed", "all"]).optional().describe("The state (default open)"),
+      label: z.string().optional().describe("Only the issues with this label"),
+      author: z.string().optional().describe("Only the issues of this author"),
+      search: z.string().optional().describe("A search of GitHub"),
+      limit,
+    }),
+    list,
+    READS,
+    ghIssueList,
+  ),
+  gh(["gh", "issue", "view"], "One issue, with its comments", z.object({ ...common, issue: z.string().min(1).describe("The number or the URL of the issue") }), item, READS, ghIssueView, ["issue"]),
+  gh(
+    ["gh", "issue", "create"],
+    "Open an issue",
+    z.object({ ...common, title: z.string().min(1).describe("The title"), body: z.string().describe("The text of the issue"), labels: z.array(z.string()).optional().describe("The labels") }),
+    created,
+    MAKES,
+    ghIssueCreate,
+  ),
+  gh(
+    ["gh", "issue", "comment"],
+    "Add a comment to an issue or a pull request",
+    z.object({ ...common, issue: z.string().min(1).describe("The number or the URL of the issue or the pull request"), body: z.string().min(1).describe("The text of the comment") }),
+    created,
+    MAKES,
+    ghIssueComment,
+    ["issue"],
+  ),
+];
+
+export const ghModule: ProcedureModule = defineModule("@procedures/gh", procedures, [shellModule]);
+
+export default ghModule;
+
+/**
+ * This function registers the procedures of @procedures/gh in a registry. The default is the
+ * global registry.
+ */
+export function registerGhProcedures(registry: ProcedureRegistry = PROCEDURE_REGISTRY): void {
+  registerModules(registry, [ghModule]);
+}

package/src/procedures/gh/index.ts

@@ -0,0 +1,13 @@
+export { ghPrList } from "./pr/list.js";
+export { ghPrView } from "./pr/view.js";
+export { ghPrChecks } from "./pr/checks.js";
+export { ghPrCreate } from "./pr/create.js";
+export { ghRunList } from "./run/list.js";
+export { ghRunView } from "./run/view.js";
+export { ghRunRerun } from "./run/rerun.js";
+export { ghReleaseList } from "./release/list.js";
+export { ghReleaseView } from "./release/view.js";
+export { ghIssueList } from "./issue/list.js";
+export { ghIssueView } from "./issue/view.js";
+export { ghIssueCreate } from "./issue/create.js";
+export { ghIssueComment } from "./issue/comment.js";

package/src/procedures/gh/issue/comment.ts

@@ -0,0 +1,17 @@
+/**
+ * gh.issue.comment procedure
+ *
+ * Add a comment to an issue or a pull request
+ */
+
+import type { ProcedureContext } from "@procedures/client";
+import type { GhIssueCommentInput, GhIssueCommentOutput } from "../../../types.js";
+import { ghArg, repoArgs, runGh, urlOf } from "../shared.js";
+
+/**
+ * Add a comment to an issue or a pull request
+ */
+export async function ghIssueComment(input: GhIssueCommentInput, ctx: ProcedureContext): Promise<GhIssueCommentOutput> {
+  const args = ["issue", "comment", ghArg("issue", input.issue), "--body", input.body, ...repoArgs(input)];
+  return { url: urlOf(await runGh(args, input, ctx)) };
+}