skuba 0.0.0-master-20230318044948

package/lib/api/github/issueComment.d.ts

@@ -0,0 +1,59 @@
+/**
+ * https://docs.github.com/en/rest/reference/issues#create-an-issue-comment
+ */
+interface PutIssueCommentParameters {
+    /**
+     * The body of the issue comment.
+     */
+    body: string;
+    /**
+     * An internal identifier for the issue comment.
+     *
+     * This can be used to scope a given `put` to a particular comment, preventing
+     * it from clobbering other comments from the same bot or user.
+     *
+     * The identifier is embedded as hidden content in the comment body.
+     */
+    internalId?: string;
+    env?: Record<string, string | undefined>;
+    /**
+     * The number that identifies the GitHub issue.
+     *
+     * If this is not provided, the number will be inferred from the GitHub Repos
+     * API by finding the latest pull request associated with the head commit.
+     *
+     * https://docs.github.com/en/rest/reference/repos#list-pull-requests-associated-with-a-commit
+     */
+    issueNumber?: number;
+    /**
+     * The ID of authenticated bot or user that is putting the issue comment.
+     *
+     * This drives our `put` behaviour, which tries to locate and edit an existing
+     * comment before creating a new one. If this is not provided, the ID will be
+     * inferred from the GitHub Users API.
+     *
+     * https://docs.github.com/en/rest/reference/users#get-the-authenticated-user
+     *
+     * If you're at SEEK and using BuildAgency's GitHub API integration, you may
+     * hardcode this to `87109344` as an optimisation to skip the user lookup.
+     *
+     * https://api.github.com/users/buildagencygitapitoken[bot]
+     */
+    userId?: number;
+}
+interface IssueComment {
+    id: number;
+}
+/**
+ * Asynchronously creates or updates a GitHub issue comment.
+ *
+ * This emulates `put` behaviour by overwriting the first existing comment by
+ * the same author on the issue, enabling use cases like a persistent bot
+ * comment at the top of the pull request that reflects the current status of a
+ * CI check.
+ *
+ * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be present
+ * on the environment.
+ */
+export declare const putIssueComment: (params: PutIssueCommentParameters) => Promise<IssueComment>;
+export {};

package/lib/api/github/issueComment.js

@@ -0,0 +1,83 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var issueComment_exports = {};
+__export(issueComment_exports, {
+  putIssueComment: () => putIssueComment
+});
+module.exports = __toCommonJS(issueComment_exports);
+var import_rest = require("@octokit/rest");
+var Git = __toESM(require("../git"));
+var import_environment = require("./environment");
+var import_pullRequest = require("./pullRequest");
+const getUserId = async (client) => {
+  const { data } = await client.users.getAuthenticated();
+  return data.id;
+};
+const putIssueComment = async (params) => {
+  const env = params.env ?? process.env;
+  const dir = process.cwd();
+  const { owner, repo } = await Git.getOwnerAndRepo({ dir });
+  const client = new import_rest.Octokit({ auth: (0, import_environment.apiTokenFromEnvironment)() });
+  const issueNumber = params.issueNumber ?? await (0, import_pullRequest.getPullRequestNumber)({ client, env });
+  if (!issueNumber) {
+    throw new Error("Failed to infer an issue number");
+  }
+  const comments = await client.issues.listComments({
+    issue_number: issueNumber,
+    owner,
+    repo
+  });
+  const userId = params.userId ?? await getUserId(client);
+  const commentId = comments.data.find(
+    (comment) => comment.user?.id === userId && (params.internalId ? comment.body?.endsWith(`
+
+<!-- ${params.internalId} -->`) : true)
+  )?.id;
+  const body = params.internalId ? [params.body.trim(), `<!-- ${params.internalId} -->`].join("\n\n") : params.body.trim();
+  const response = await (commentId ? client.issues.updateComment({
+    body,
+    comment_id: commentId,
+    issue_number: issueNumber,
+    owner,
+    repo
+  }) : client.issues.createComment({
+    body,
+    issue_number: issueNumber,
+    owner,
+    repo
+  }));
+  return {
+    id: response.data.id
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  putIssueComment
+});
+//# sourceMappingURL=issueComment.js.map

package/lib/api/github/issueComment.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/github/issueComment.ts"],
+  "sourcesContent": ["import { Octokit } from '@octokit/rest';\n\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\nimport { getPullRequestNumber } from './pullRequest';\n\nconst getUserId = async (client: Octokit): Promise<number> => {\n  const { data } = await client.users.getAuthenticated();\n\n  return data.id;\n};\n\n/**\n * https://docs.github.com/en/rest/reference/issues#create-an-issue-comment\n */\ninterface PutIssueCommentParameters {\n  /**\n   * The body of the issue comment.\n   */\n  body: string;\n\n  /**\n   * An internal identifier for the issue comment.\n   *\n   * This can be used to scope a given `put` to a particular comment, preventing\n   * it from clobbering other comments from the same bot or user.\n   *\n   * The identifier is embedded as hidden content in the comment body.\n   */\n  internalId?: string;\n\n  env?: Record<string, string | undefined>;\n\n  /**\n   * The number that identifies the GitHub issue.\n   *\n   * If this is not provided, the number will be inferred from the GitHub Repos\n   * API by finding the latest pull request associated with the head commit.\n   *\n   * https://docs.github.com/en/rest/reference/repos#list-pull-requests-associated-with-a-commit\n   */\n  issueNumber?: number;\n\n  /**\n   * The ID of authenticated bot or user that is putting the issue comment.\n   *\n   * This drives our `put` behaviour, which tries to locate and edit an existing\n   * comment before creating a new one. If this is not provided, the ID will be\n   * inferred from the GitHub Users API.\n   *\n   * https://docs.github.com/en/rest/reference/users#get-the-authenticated-user\n   *\n   * If you're at SEEK and using BuildAgency's GitHub API integration, you may\n   * hardcode this to `87109344` as an optimisation to skip the user lookup.\n   *\n   * https://api.github.com/users/buildagencygitapitoken[bot]\n   */\n  userId?: number;\n}\n\ninterface IssueComment {\n  id: number;\n}\n\n/**\n * Asynchronously creates or updates a GitHub issue comment.\n *\n * This emulates `put` behaviour by overwriting the first existing comment by\n * the same author on the issue, enabling use cases like a persistent bot\n * comment at the top of the pull request that reflects the current status of a\n * CI check.\n *\n * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be present\n * on the environment.\n */\nexport const putIssueComment = async (\n  params: PutIssueCommentParameters,\n): Promise<IssueComment> => {\n  const env = params.env ?? process.env;\n\n  const dir = process.cwd();\n\n  const { owner, repo } = await Git.getOwnerAndRepo({ dir });\n\n  const client = new Octokit({ auth: apiTokenFromEnvironment() });\n\n  const issueNumber =\n    params.issueNumber ?? (await getPullRequestNumber({ client, env }));\n\n  if (!issueNumber) {\n    throw new Error('Failed to infer an issue number');\n  }\n\n  const comments = await client.issues.listComments({\n    issue_number: issueNumber,\n    owner,\n    repo,\n  });\n\n  const userId = params.userId ?? (await getUserId(client));\n\n  const commentId = comments.data.find(\n    (comment) =>\n      comment.user?.id === userId &&\n      (params.internalId\n        ? comment.body?.endsWith(`\\n\\n<!-- ${params.internalId} -->`)\n        : true),\n  )?.id;\n\n  const body = params.internalId\n    ? [params.body.trim(), `<!-- ${params.internalId} -->`].join('\\n\\n')\n    : params.body.trim();\n\n  const response = await (commentId\n    ? client.issues.updateComment({\n        body,\n        comment_id: commentId,\n        issue_number: issueNumber,\n        owner,\n        repo,\n      })\n    : client.issues.createComment({\n        body,\n        issue_number: issueNumber,\n        owner,\n        repo,\n      }));\n\n  return {\n    id: response.data.id,\n  };\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAExB,UAAqB;AAErB,yBAAwC;AACxC,yBAAqC;AAErC,MAAM,YAAY,OAAO,WAAqC;AAC5D,QAAM,EAAE,KAAK,IAAI,MAAM,OAAO,MAAM,iBAAiB;AAErD,SAAO,KAAK;AACd;AAiEO,MAAM,kBAAkB,OAC7B,WAC0B;AAC1B,QAAM,MAAM,OAAO,OAAO,QAAQ;AAElC,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,EAAE,OAAO,KAAK,IAAI,MAAM,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAEzD,QAAM,SAAS,IAAI,oBAAQ,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAE9D,QAAM,cACJ,OAAO,eAAgB,UAAM,yCAAqB,EAAE,QAAQ,IAAI,CAAC;AAEnE,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI,MAAM,iCAAiC;AAAA,EACnD;AAEA,QAAM,WAAW,MAAM,OAAO,OAAO,aAAa;AAAA,IAChD,cAAc;AAAA,IACd;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,SAAS,OAAO,UAAW,MAAM,UAAU,MAAM;AAEvD,QAAM,YAAY,SAAS,KAAK;AAAA,IAC9B,CAAC,YACC,QAAQ,MAAM,OAAO,WACpB,OAAO,aACJ,QAAQ,MAAM,SAAS;AAAA;AAAA,OAAY,OAAO,gBAAgB,IAC1D;AAAA,EACR,GAAG;AAEH,QAAM,OAAO,OAAO,aAChB,CAAC,OAAO,KAAK,KAAK,GAAG,QAAQ,OAAO,gBAAgB,EAAE,KAAK,MAAM,IACjE,OAAO,KAAK,KAAK;AAErB,QAAM,WAAW,OAAO,YACpB,OAAO,OAAO,cAAc;AAAA,IAC1B;AAAA,IACA,YAAY;AAAA,IACZ,cAAc;AAAA,IACd;AAAA,IACA;AAAA,EACF,CAAC,IACD,OAAO,OAAO,cAAc;AAAA,IAC1B;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA;AAAA,EACF,CAAC;AAEL,SAAO;AAAA,IACL,IAAI,SAAS,KAAK;AAAA,EACpB;AACF;",
+  "names": []
+}

package/lib/api/github/pullRequest.d.ts

@@ -0,0 +1,21 @@
+import { Octokit } from '@octokit/rest';
+interface GetPullRequestParameters {
+    /**
+     * A preconstructed Octokit client to interact with GitHub's APIs.
+     *
+     * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be
+     * present on the environment if this is not provided.
+     */
+    client?: Octokit;
+    env?: Record<string, string | undefined>;
+}
+/**
+ * Gets the number of the current pull request.
+ *
+ * This tries to extract the pull request from common CI environment variables,
+ * and falls back to querying the GitHub Repos API for the latest pull request
+ * associated with the head commit. An error is thrown if there are no
+ * associated pull requests, or if they are all closed or locked.
+ */
+export declare const getPullRequestNumber: (params?: GetPullRequestParameters) => Promise<number>;
+export {};

package/lib/api/github/pullRequest.js

@@ -0,0 +1,68 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pullRequest_exports = {};
+__export(pullRequest_exports, {
+  getPullRequestNumber: () => getPullRequestNumber
+});
+module.exports = __toCommonJS(pullRequest_exports);
+var import_rest = require("@octokit/rest");
+var Git = __toESM(require("../git"));
+var import_environment = require("./environment");
+const getPullRequestNumber = async (params = {}) => {
+  const env = params.env ?? process.env;
+  const dir = process.cwd();
+  const number = Number(
+    env.BUILDKITE_PULL_REQUEST ?? env.GITHUB_REF?.replace(/^refs\/pull\/(\d+).*$/, "$1")
+  );
+  if (Number.isSafeInteger(number)) {
+    return number;
+  }
+  const client = params.client ?? new import_rest.Octokit({ auth: (0, import_environment.apiTokenFromEnvironment)() });
+  const [commitId, { owner, repo }] = await Promise.all([
+    Git.getHeadCommitId({ dir, env }),
+    Git.getOwnerAndRepo({ dir })
+  ]);
+  const response = await client.repos.listPullRequestsAssociatedWithCommit({
+    commit_sha: commitId,
+    owner,
+    repo
+  });
+  const data = response.data.filter((pr) => pr.state === "open" && !pr.locked).sort((a, b) => b.updated_at.localeCompare(a.updated_at));
+  if (!data.length) {
+    throw new Error(
+      `Commit ${commitId} is not associated with an open GitHub pull request`
+    );
+  }
+  return data[0].number;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getPullRequestNumber
+});
+//# sourceMappingURL=pullRequest.js.map

package/lib/api/github/pullRequest.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/github/pullRequest.ts"],
+  "sourcesContent": ["import { Octokit } from '@octokit/rest';\n\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\n\ninterface GetPullRequestParameters {\n  /**\n   * A preconstructed Octokit client to interact with GitHub's APIs.\n   *\n   * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be\n   * present on the environment if this is not provided.\n   */\n  client?: Octokit;\n\n  env?: Record<string, string | undefined>;\n}\n\n/**\n * Gets the number of the current pull request.\n *\n * This tries to extract the pull request from common CI environment variables,\n * and falls back to querying the GitHub Repos API for the latest pull request\n * associated with the head commit. An error is thrown if there are no\n * associated pull requests, or if they are all closed or locked.\n */\nexport const getPullRequestNumber = async (\n  params: GetPullRequestParameters = {},\n): Promise<number> => {\n  const env = params.env ?? process.env;\n\n  const dir = process.cwd();\n\n  const number = Number(\n    env.BUILDKITE_PULL_REQUEST ??\n      env.GITHUB_REF?.replace(/^refs\\/pull\\/(\\d+).*$/, '$1'),\n  );\n\n  if (Number.isSafeInteger(number)) {\n    return number;\n  }\n\n  const client =\n    params.client ?? new Octokit({ auth: apiTokenFromEnvironment() });\n\n  const [commitId, { owner, repo }] = await Promise.all([\n    Git.getHeadCommitId({ dir, env }),\n    Git.getOwnerAndRepo({ dir }),\n  ]);\n\n  const response = await client.repos.listPullRequestsAssociatedWithCommit({\n    commit_sha: commitId,\n    owner,\n    repo,\n  });\n\n  const data = response.data\n    .filter((pr) => pr.state === 'open' && !pr.locked)\n    .sort((a, b) => b.updated_at.localeCompare(a.updated_at));\n\n  if (!data.length) {\n    throw new Error(\n      `Commit ${commitId} is not associated with an open GitHub pull request`,\n    );\n  }\n\n  return data[0].number;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAExB,UAAqB;AAErB,yBAAwC;AAsBjC,MAAM,uBAAuB,OAClC,SAAmC,CAAC,MAChB;AACpB,QAAM,MAAM,OAAO,OAAO,QAAQ;AAElC,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,SAAS;AAAA,IACb,IAAI,0BACF,IAAI,YAAY,QAAQ,yBAAyB,IAAI;AAAA,EACzD;AAEA,MAAI,OAAO,cAAc,MAAM,GAAG;AAChC,WAAO;AAAA,EACT;AAEA,QAAM,SACJ,OAAO,UAAU,IAAI,oBAAQ,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAElE,QAAM,CAAC,UAAU,EAAE,OAAO,KAAK,CAAC,IAAI,MAAM,QAAQ,IAAI;AAAA,IACpD,IAAI,gBAAgB,EAAE,KAAK,IAAI,CAAC;AAAA,IAChC,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,EAC7B,CAAC;AAED,QAAM,WAAW,MAAM,OAAO,MAAM,qCAAqC;AAAA,IACvE,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,OAAO,SAAS,KACnB,OAAO,CAAC,OAAO,GAAG,UAAU,UAAU,CAAC,GAAG,MAAM,EAChD,KAAK,CAAC,GAAG,MAAM,EAAE,WAAW,cAAc,EAAE,UAAU,CAAC;AAE1D,MAAI,CAAC,KAAK,QAAQ;AAChB,UAAM,IAAI;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO,KAAK,CAAC,EAAE;AACjB;",
+  "names": []
+}

package/lib/api/github/push.d.ts

@@ -0,0 +1,79 @@
+import type { FileAddition, FileDeletion } from '@octokit/graphql-schema';
+import * as Git from '../git';
+interface UploadAllFileChangesParams {
+    dir: string;
+    /**
+     * The branch name
+     */
+    branch: string;
+    /**
+     * The headline of the commit message
+     */
+    messageHeadline: string;
+    /**
+     * File changes to exclude from the upload.
+     *
+     * Defaults to `[]` (no exclusions).
+     */
+    ignore?: Git.ChangedFile[];
+    /**
+     * The body of the commit message
+     */
+    messageBody?: string;
+    /**
+     * Updates the local Git repository to match the new remote branch state
+     */
+    updateLocal?: boolean;
+}
+/**
+ * Retrieves all file changes from the local Git repository using
+ * `getChangedFiles`, then uploads the changes to a specified GitHub branch
+ * using `uploadFileChanges`.
+ *
+ * Returns the commit ID, or `undefined` if there are no changes to commit.
+ *
+ * The file changes will appear as verified commits on GitHub.
+ *
+ * This will not update the local Git repository unless `updateLocal` is
+ * specified.
+ */
+export declare const uploadAllFileChanges: ({ branch, dir, messageHeadline, ignore, messageBody, updateLocal, }: UploadAllFileChangesParams) => Promise<string | undefined>;
+export interface FileChanges {
+    additions: FileAddition[];
+    deletions: FileDeletion[];
+}
+/**
+ * Takes a list of `ChangedFiles`, reads them from the file system, and maps
+ * them to GitHub GraphQL `FileChanges`.
+ *
+ * https://docs.github.com/en/graphql/reference/input-objects#filechanges
+ */
+export declare const readFileChanges: (changedFiles: Git.ChangedFile[]) => Promise<FileChanges>;
+interface UploadFileChangesParams {
+    dir: string;
+    /**
+     * The branch name
+     */
+    branch: string;
+    /**
+     * The headline of the commit message
+     */
+    messageHeadline: string;
+    /**
+     * The body of the commit message
+     */
+    messageBody?: string;
+    /**
+     * File additions and deletions
+     */
+    fileChanges: FileChanges;
+}
+/**
+ * Uploads file changes from the local workspace to a specified GitHub branch.
+ *
+ * The file changes will appear as verified commits on GitHub.
+ *
+ * This will not update the local Git repository.
+ */
+export declare const uploadFileChanges: ({ dir, branch, messageHeadline, messageBody, fileChanges, }: UploadFileChangesParams) => Promise<string>;
+export {};

package/lib/api/github/push.js

@@ -0,0 +1,158 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var push_exports = {};
+__export(push_exports, {
+  readFileChanges: () => readFileChanges,
+  uploadAllFileChanges: () => uploadAllFileChanges,
+  uploadFileChanges: () => uploadFileChanges
+});
+module.exports = __toCommonJS(push_exports);
+var import_graphql = require("@octokit/graphql");
+var import_fs_extra = __toESM(require("fs-extra"));
+var Git = __toESM(require("../git"));
+var import_environment = require("./environment");
+const uploadAllFileChanges = async ({
+  branch,
+  dir,
+  messageHeadline,
+  ignore,
+  messageBody,
+  updateLocal = false
+}) => {
+  const changedFiles = await Git.getChangedFiles({ dir, ignore });
+  if (!changedFiles.length) {
+    return;
+  }
+  const fileChanges = await readFileChanges(changedFiles);
+  const commitId = await uploadFileChanges({
+    dir,
+    branch,
+    messageHeadline,
+    messageBody,
+    fileChanges
+  });
+  if (updateLocal) {
+    await Promise.all(
+      [...fileChanges.additions, ...fileChanges.deletions].map(
+        (file) => import_fs_extra.default.rm(file.path)
+      )
+    );
+    await Git.fastForwardBranch({
+      ref: branch,
+      auth: { type: "gitHubApp" },
+      dir
+    });
+  }
+  return commitId;
+};
+const readFileChanges = async (changedFiles) => {
+  const { added, deleted } = changedFiles.reduce(
+    (files, changedFile) => {
+      const filePath = changedFile.path;
+      if (changedFile.state === "deleted") {
+        files.deleted.push(filePath);
+      } else {
+        files.added.push(filePath);
+      }
+      return files;
+    },
+    { added: [], deleted: [] }
+  );
+  const additions = await Promise.all(
+    added.map(async (filePath) => ({
+      path: filePath,
+      contents: await import_fs_extra.default.promises.readFile(filePath, {
+        encoding: "base64"
+      })
+    }))
+  );
+  const deletions = deleted.map((filePath) => ({
+    path: filePath
+  }));
+  return {
+    additions,
+    deletions
+  };
+};
+const uploadFileChanges = async ({
+  dir,
+  branch,
+  messageHeadline,
+  messageBody,
+  fileChanges
+}) => {
+  const authToken = (0, import_environment.apiTokenFromEnvironment)();
+  if (!authToken) {
+    throw new Error(
+      "Could not read a GitHub API token from the environment. Please set GITHUB_API_TOKEN or GITHUB_TOKEN."
+    );
+  }
+  const [{ owner, repo }, headCommitId] = await Promise.all([
+    Git.getOwnerAndRepo({ dir }),
+    Git.getHeadCommitId({ dir })
+  ]);
+  const input = {
+    branch: {
+      repositoryNameWithOwner: `${owner}/${repo}`,
+      branchName: branch
+    },
+    message: {
+      headline: messageHeadline,
+      body: messageBody
+    },
+    expectedHeadOid: headCommitId,
+    clientMutationId: "skuba",
+    fileChanges
+  };
+  const result = await (0, import_graphql.graphql)(
+    `
+      mutation Mutation($input: CreateCommitOnBranchInput!) {
+        createCommitOnBranch(input: $input) {
+          commit {
+            oid
+          }
+        }
+      }
+    `,
+    {
+      input,
+      headers: {
+        authorization: `Bearer ${authToken}`
+      }
+    }
+  );
+  return result.createCommitOnBranch.commit.oid;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  readFileChanges,
+  uploadAllFileChanges,
+  uploadFileChanges
+});
+//# sourceMappingURL=push.js.map

package/lib/api/github/push.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/github/push.ts"],
+  "sourcesContent": ["import { graphql } from '@octokit/graphql';\nimport type {\n  CreateCommitOnBranchInput,\n  FileAddition,\n  FileDeletion,\n} from '@octokit/graphql-schema';\nimport fs from 'fs-extra';\n\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\n\ninterface CreateCommitResult {\n  createCommitOnBranch: {\n    commit: {\n      oid: string;\n    };\n  };\n}\n\ninterface UploadAllFileChangesParams {\n  dir: string;\n  /**\n   * The branch name\n   */\n  branch: string;\n  /**\n   * The headline of the commit message\n   */\n  messageHeadline: string;\n\n  /**\n   * File changes to exclude from the upload.\n   *\n   * Defaults to `[]` (no exclusions).\n   */\n  ignore?: Git.ChangedFile[];\n  /**\n   * The body of the commit message\n   */\n  messageBody?: string;\n  /**\n   * Updates the local Git repository to match the new remote branch state\n   */\n  updateLocal?: boolean;\n}\n\n/**\n * Retrieves all file changes from the local Git repository using\n * `getChangedFiles`, then uploads the changes to a specified GitHub branch\n * using `uploadFileChanges`.\n *\n * Returns the commit ID, or `undefined` if there are no changes to commit.\n *\n * The file changes will appear as verified commits on GitHub.\n *\n * This will not update the local Git repository unless `updateLocal` is\n * specified.\n */\nexport const uploadAllFileChanges = async ({\n  branch,\n  dir,\n  messageHeadline,\n\n  ignore,\n  messageBody,\n  updateLocal = false,\n}: UploadAllFileChangesParams): Promise<string | undefined> => {\n  const changedFiles = await Git.getChangedFiles({ dir, ignore });\n\n  if (!changedFiles.length) {\n    return;\n  }\n\n  const fileChanges = await readFileChanges(changedFiles);\n\n  const commitId = await uploadFileChanges({\n    dir,\n    branch,\n    messageHeadline,\n    messageBody,\n    fileChanges,\n  });\n\n  if (updateLocal) {\n    await Promise.all(\n      [...fileChanges.additions, ...fileChanges.deletions].map((file) =>\n        fs.rm(file.path),\n      ),\n    );\n\n    await Git.fastForwardBranch({\n      ref: branch,\n      auth: { type: 'gitHubApp' },\n      dir,\n    });\n  }\n\n  return commitId;\n};\n\nexport interface FileChanges {\n  additions: FileAddition[];\n  deletions: FileDeletion[];\n}\n\n/**\n * Takes a list of `ChangedFiles`, reads them from the file system, and maps\n * them to GitHub GraphQL `FileChanges`.\n *\n * https://docs.github.com/en/graphql/reference/input-objects#filechanges\n */\nexport const readFileChanges = async (\n  changedFiles: Git.ChangedFile[],\n): Promise<FileChanges> => {\n  const { added, deleted } = changedFiles.reduce<{\n    added: string[];\n    deleted: string[];\n  }>(\n    (files, changedFile) => {\n      const filePath = changedFile.path;\n      if (changedFile.state === 'deleted') {\n        files.deleted.push(filePath);\n      } else {\n        files.added.push(filePath);\n      }\n\n      return files;\n    },\n    { added: [], deleted: [] },\n  );\n\n  const additions: FileAddition[] = await Promise.all(\n    added.map(async (filePath) => ({\n      path: filePath,\n      contents: await fs.promises.readFile(filePath, {\n        encoding: 'base64',\n      }),\n    })),\n  );\n\n  const deletions: FileDeletion[] = deleted.map((filePath) => ({\n    path: filePath,\n  }));\n\n  return {\n    additions,\n    deletions,\n  };\n};\n\ninterface UploadFileChangesParams {\n  dir: string;\n  /**\n   * The branch name\n   */\n  branch: string;\n  /**\n   * The headline of the commit message\n   */\n  messageHeadline: string;\n  /**\n   * The body of the commit message\n   */\n  messageBody?: string;\n  /**\n   * File additions and deletions\n   */\n  fileChanges: FileChanges;\n}\n\n/**\n * Uploads file changes from the local workspace to a specified GitHub branch.\n *\n * The file changes will appear as verified commits on GitHub.\n *\n * This will not update the local Git repository.\n */\nexport const uploadFileChanges = async ({\n  dir,\n  branch,\n  messageHeadline,\n  messageBody,\n  fileChanges,\n}: UploadFileChangesParams): Promise<string> => {\n  const authToken = apiTokenFromEnvironment();\n  if (!authToken) {\n    throw new Error(\n      'Could not read a GitHub API token from the environment. Please set GITHUB_API_TOKEN or GITHUB_TOKEN.',\n    );\n  }\n\n  const [{ owner, repo }, headCommitId] = await Promise.all([\n    Git.getOwnerAndRepo({ dir }),\n    Git.getHeadCommitId({ dir }),\n  ]);\n\n  const input: CreateCommitOnBranchInput = {\n    branch: {\n      repositoryNameWithOwner: `${owner}/${repo}`,\n      branchName: branch,\n    },\n    message: {\n      headline: messageHeadline,\n      body: messageBody,\n    },\n    expectedHeadOid: headCommitId,\n    clientMutationId: 'skuba',\n    fileChanges,\n  };\n\n  const result = await graphql<CreateCommitResult>(\n    `\n      mutation Mutation($input: CreateCommitOnBranchInput!) {\n        createCommitOnBranch(input: $input) {\n          commit {\n            oid\n          }\n        }\n      }\n    `,\n    {\n      input,\n      headers: {\n        authorization: `Bearer ${authToken}`,\n      },\n    },\n  );\n\n  return result.createCommitOnBranch.commit.oid;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAAwB;AAMxB,sBAAe;AAEf,UAAqB;AAErB,yBAAwC;AAiDjC,MAAM,uBAAuB,OAAO;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA,cAAc;AAChB,MAA+D;AAC7D,QAAM,eAAe,MAAM,IAAI,gBAAgB,EAAE,KAAK,OAAO,CAAC;AAE9D,MAAI,CAAC,aAAa,QAAQ;AACxB;AAAA,EACF;AAEA,QAAM,cAAc,MAAM,gBAAgB,YAAY;AAEtD,QAAM,WAAW,MAAM,kBAAkB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,MAAI,aAAa;AACf,UAAM,QAAQ;AAAA,MACZ,CAAC,GAAG,YAAY,WAAW,GAAG,YAAY,SAAS,EAAE;AAAA,QAAI,CAAC,SACxD,gBAAAA,QAAG,GAAG,KAAK,IAAI;AAAA,MACjB;AAAA,IACF;AAEA,UAAM,IAAI,kBAAkB;AAAA,MAC1B,KAAK;AAAA,MACL,MAAM,EAAE,MAAM,YAAY;AAAA,MAC1B;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AACT;AAaO,MAAM,kBAAkB,OAC7B,iBACyB;AACzB,QAAM,EAAE,OAAO,QAAQ,IAAI,aAAa;AAAA,IAItC,CAAC,OAAO,gBAAgB;AACtB,YAAM,WAAW,YAAY;AAC7B,UAAI,YAAY,UAAU,WAAW;AACnC,cAAM,QAAQ,KAAK,QAAQ;AAAA,MAC7B,OAAO;AACL,cAAM,MAAM,KAAK,QAAQ;AAAA,MAC3B;AAEA,aAAO;AAAA,IACT;AAAA,IACA,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE;AAAA,EAC3B;AAEA,QAAM,YAA4B,MAAM,QAAQ;AAAA,IAC9C,MAAM,IAAI,OAAO,cAAc;AAAA,MAC7B,MAAM;AAAA,MACN,UAAU,MAAM,gBAAAA,QAAG,SAAS,SAAS,UAAU;AAAA,QAC7C,UAAU;AAAA,MACZ,CAAC;AAAA,IACH,EAAE;AAAA,EACJ;AAEA,QAAM,YAA4B,QAAQ,IAAI,CAAC,cAAc;AAAA,IAC3D,MAAM;AAAA,EACR,EAAE;AAEF,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AA6BO,MAAM,oBAAoB,OAAO;AAAA,EACtC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAAgD;AAC9C,QAAM,gBAAY,4CAAwB;AAC1C,MAAI,CAAC,WAAW;AACd,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,CAAC,EAAE,OAAO,KAAK,GAAG,YAAY,IAAI,MAAM,QAAQ,IAAI;AAAA,IACxD,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,IAC3B,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,EAC7B,CAAC;AAED,QAAM,QAAmC;AAAA,IACvC,QAAQ;AAAA,MACN,yBAAyB,GAAG,SAAS;AAAA,MACrC,YAAY;AAAA,IACd;AAAA,IACA,SAAS;AAAA,MACP,UAAU;AAAA,MACV,MAAM;AAAA,IACR;AAAA,IACA,iBAAiB;AAAA,IACjB,kBAAkB;AAAA,IAClB;AAAA,EACF;AAEA,QAAM,SAAS,UAAM;AAAA,IACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA;AAAA,MACE;AAAA,MACA,SAAS;AAAA,QACP,eAAe,UAAU;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAEA,SAAO,OAAO,qBAAqB,OAAO;AAC5C;",
+  "names": ["fs"]
+}

package/lib/api/jest/index.d.ts

@@ -0,0 +1,144 @@
+import type { Config } from '@jest/types';
+/**
+ * Set of Jest options that are recommended and supported for customisation.
+ *
+ * While we technically accept anything compatible with `Config.InitialOptions`,
+ * these are tacitly endorsed for our use cases and receive IntelliSense.
+ */
+type DefaultOptions = 'collectCoverage' | 'collectCoverageFrom' | 'coveragePathIgnorePatterns' | 'coverageThreshold' | 'displayName' | 'globals' | 'globalSetup' | 'globalTeardown' | 'projects' | 'setupFiles' | 'setupFilesAfterEnv' | 'snapshotSerializers' | 'testEnvironment' | 'testPathIgnorePatterns' | 'testTimeout' | 'watchPathIgnorePatterns';
+/**
+ * Merge additional Jest options into the **skuba** preset.
+ *
+ * This concatenates array options like `testPathIgnorePatterns`.
+ */
+export declare const mergePreset: <AdditionalOptions extends "filter" | "json" | "silent" | "cache" | "runtime" | "watch" | "runner" | "projects" | "id" | "automock" | "cacheDirectory" | "clearMocks" | "coveragePathIgnorePatterns" | "dependencyExtractor" | "detectLeaks" | "detectOpenHandles" | "displayName" | "errorOnDeprecated" | "extensionsToTreatAsEsm" | "fakeTimers" | "forceCoverageMatch" | "globalSetup" | "globalTeardown" | "globals" | "haste" | "injectGlobals" | "moduleDirectories" | "moduleFileExtensions" | "moduleNameMapper" | "modulePathIgnorePatterns" | "modulePaths" | "preset" | "prettierPath" | "resetMocks" | "resetModules" | "resolver" | "restoreMocks" | "rootDir" | "roots" | "sandboxInjectedGlobals" | "setupFiles" | "setupFilesAfterEnv" | "skipFilter" | "skipNodeResolution" | "slowTestThreshold" | "snapshotResolver" | "snapshotSerializers" | "snapshotFormat" | "testEnvironment" | "testEnvironmentOptions" | "testMatch" | "testLocationInResults" | "testPathIgnorePatterns" | "testRegex" | "testRunner" | "transform" | "transformIgnorePatterns" | "watchPathIgnorePatterns" | "unmockedModulePathPatterns" | "workerIdleMemoryLimit" | "bail" | "ci" | "changedFilesWithAncestor" | "changedSince" | "collectCoverage" | "collectCoverageFrom" | "coverageDirectory" | "coverageProvider" | "coverageReporters" | "coverageThreshold" | "expand" | "findRelatedTests" | "forceExit" | "reporters" | "logHeapUsage" | "lastCommit" | "listTests" | "maxConcurrency" | "maxWorkers" | "noStackTrace" | "notify" | "notifyMode" | "onlyChanged" | "onlyFailures" | "outputFile" | "passWithNoTests" | "replname" | "runTestsByPath" | "showSeed" | "testFailureExitCode" | "testNamePattern" | "testResultsProcessor" | "testSequencer" | "testTimeout" | "updateSnapshot" | "useStderr" | "verbose" | "watchAll" | "watchman" | "watchPlugins">(options: Pick<Partial<{
+    automock: boolean;
+    bail: number | boolean;
+    cache: boolean;
+    cacheDirectory: string;
+    ci: boolean;
+    clearMocks: boolean;
+    changedFilesWithAncestor: boolean;
+    changedSince: string;
+    collectCoverage: boolean;
+    collectCoverageFrom: string[];
+    coverageDirectory: string;
+    coveragePathIgnorePatterns: string[];
+    coverageProvider: "v8" | "babel";
+    coverageReporters: Config.CoverageReporters;
+    coverageThreshold: {
+        [path: string]: Config.CoverageThresholdValue;
+        global: Config.CoverageThresholdValue;
+    };
+    dependencyExtractor: string;
+    detectLeaks: boolean;
+    detectOpenHandles: boolean;
+    displayName: string | Config.DisplayName;
+    expand: boolean;
+    extensionsToTreatAsEsm: string[];
+    fakeTimers: Config.GlobalFakeTimersConfig & ((Config.FakeTimersConfig & {
+        now?: number | undefined;
+    }) | Config.LegacyFakeTimersConfig);
+    filter: string;
+    findRelatedTests: boolean;
+    forceCoverageMatch: string[];
+    forceExit: boolean;
+    json: boolean;
+    globals: Config.ConfigGlobals;
+    globalSetup: string | null | undefined;
+    globalTeardown: string | null | undefined;
+    haste: Config.HasteConfig;
+    id: string;
+    injectGlobals: boolean;
+    reporters: (string | Config.ReporterConfig)[];
+    logHeapUsage: boolean;
+    lastCommit: boolean;
+    listTests: boolean;
+    maxConcurrency: number;
+    maxWorkers: string | number;
+    moduleDirectories: string[];
+    moduleFileExtensions: string[];
+    moduleNameMapper: {
+        [key: string]: string | string[];
+    };
+    modulePathIgnorePatterns: string[];
+    modulePaths: string[];
+    noStackTrace: boolean;
+    notify: boolean;
+    notifyMode: string;
+    onlyChanged: boolean;
+    onlyFailures: boolean;
+    outputFile: string;
+    passWithNoTests: boolean;
+    preset: string | null | undefined;
+    prettierPath: string | null | undefined;
+    projects: (string | Config.InitialProjectOptions)[];
+    replname: string | null | undefined;
+    resetMocks: boolean;
+    resetModules: boolean;
+    resolver: string | null | undefined;
+    restoreMocks: boolean;
+    rootDir: string;
+    roots: string[];
+    runner: string;
+    runTestsByPath: boolean;
+    runtime: string;
+    sandboxInjectedGlobals: string[];
+    setupFiles: string[];
+    setupFilesAfterEnv: string[];
+    showSeed: boolean;
+    silent: boolean;
+    skipFilter: boolean;
+    skipNodeResolution: boolean;
+    slowTestThreshold: number;
+    snapshotResolver: string;
+    snapshotSerializers: string[];
+    snapshotFormat: Partial<{
+        readonly callToJSON: boolean;
+        readonly compareKeys: null;
+        readonly escapeRegex: boolean;
+        readonly escapeString: boolean;
+        readonly highlight: boolean;
+        readonly indent: number;
+        readonly maxDepth: number;
+        readonly maxWidth: number;
+        readonly min: boolean;
+        readonly printBasicPrototype: boolean;
+        readonly printFunctionName: boolean;
+        readonly theme: Partial<{
+            readonly value: string;
+            readonly tag: string;
+            readonly content: string;
+            readonly comment: string;
+            readonly prop: string;
+        }>;
+    }>;
+    errorOnDeprecated: boolean;
+    testEnvironment: string;
+    testEnvironmentOptions: Record<string, unknown>;
+    testFailureExitCode: string | number;
+    testLocationInResults: boolean;
+    testMatch: string[];
+    testNamePattern: string;
+    testPathIgnorePatterns: string[];
+    testRegex: string | string[];
+    testResultsProcessor: string;
+    testRunner: string;
+    testSequencer: string;
+    testTimeout: number;
+    transform: {
+        [regex: string]: string | Config.TransformerConfig;
+    };
+    transformIgnorePatterns: string[];
+    watchPathIgnorePatterns: string[];
+    unmockedModulePathPatterns: string[];
+    updateSnapshot: boolean;
+    useStderr: boolean;
+    verbose?: boolean | undefined;
+    watch: boolean;
+    watchAll: boolean;
+    watchman: boolean;
+    watchPlugins: (string | [string, Record<string, unknown>])[];
+    workerIdleMemoryLimit: string | number;
+}>, DefaultOptions | AdditionalOptions>) => Config.InitialOptions;
+export {};