skuba 8.1.0 → 8.2.0

package/lib/api/github/checkRun.js

@@ -31,10 +31,10 @@ __export(checkRun_exports, {
   createCheckRun: () => createCheckRun
 });
 module.exports = __toCommonJS(checkRun_exports);
-var import_rest = require("@octokit/rest");
 var import_logging = require("../../utils/logging");
 var Git = __toESM(require("../git"));
 var import_environment = require("./environment");
+var import_octokit = require("./octokit");
 const GITHUB_MAX_ANNOTATIONS = 50;
 const suffixTitle = (title, inputAnnotations) => {
   const addedAnnotations = inputAnnotations > GITHUB_MAX_ANNOTATIONS ? GITHUB_MAX_ANNOTATIONS : inputAnnotations;
@@ -59,7 +59,7 @@ const createCheckRun = async ({
     Git.getHeadCommitId({ dir }),
     Git.getOwnerAndRepo({ dir })
   ]);
-  const client = new import_rest.Octokit({ auth: (0, import_environment.apiTokenFromEnvironment)() });
+  const client = await (0, import_octokit.createRestClient)({ auth: (0, import_environment.apiTokenFromEnvironment)() });
   await client.checks.create({
     conclusion,
     head_sha: commitId,

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/api/github/checkRun.ts"],
-  "sourcesContent": ["import { Octokit } from '@octokit/rest';\nimport type { Endpoints } from '@octokit/types';\n\nimport { pluralise } from '../../utils/logging';\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\n\ntype Output = NonNullable<\n  Endpoints['PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}']['parameters']['output']\n>;\n\nexport type Annotation = NonNullable<Output['annotations']>[number];\n\nconst GITHUB_MAX_ANNOTATIONS = 50;\n\n/**\n * Suffixes the title with the number of annotations added, e.g.\n *\n * ```text\n * Build #12 failed (24 annotations added)\n * ```\n */\nconst suffixTitle = (title: string, inputAnnotations: number): string => {\n  const addedAnnotations =\n    inputAnnotations > GITHUB_MAX_ANNOTATIONS\n      ? GITHUB_MAX_ANNOTATIONS\n      : inputAnnotations;\n\n  return `${title} (${pluralise(addedAnnotations, 'annotation')} added)`;\n};\n\n/**\n * Enriches the summary with more context about the check run.\n */\nconst createEnrichedSummary = (\n  summary: string,\n  inputAnnotations: number,\n): string =>\n  [\n    summary,\n    ...(inputAnnotations > GITHUB_MAX_ANNOTATIONS\n      ? [\n          `${inputAnnotations} annotations were provided, but only the first ${GITHUB_MAX_ANNOTATIONS} are visible in GitHub.`,\n        ]\n      : []),\n  ].join('\\n\\n');\n\n/**\n * {@link https://docs.github.com/en/rest/reference/checks#create-a-check-run}\n */\ninterface CreateCheckRunParameters {\n  /**\n   * Adds information from your analysis to specific lines of code.\n   * Annotations are visible on GitHub in the **Checks** and **Files changed**\n   * tab of the pull request.\n   */\n  annotations: Annotation[];\n\n  /**\n   * The final conclusion of the check.\n   */\n  conclusion: 'failure' | 'success';\n\n  /**\n   * The name of the check. For example, \"code-coverage\".\n   */\n  name: string;\n\n  /**\n   * The summary of the check run. This parameter supports Markdown.\n   */\n  summary: string;\n\n  /**\n   * The details of the check run. This parameter supports Markdown.\n   */\n  text?: string;\n\n  /**\n   * The title of the check run.\n   */\n  title: string;\n}\n\n/**\n * Asynchronously creates a GitHub check run with annotations.\n *\n * The first 50 `annotations` are written in full to GitHub.\n *\n * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with the `checks:write` permission\n * must be present on the environment.\n */\nexport const createCheckRun = async ({\n  annotations,\n  conclusion,\n  name,\n  summary,\n  text,\n  title,\n}: CreateCheckRunParameters): Promise<void> => {\n  const dir = process.cwd();\n\n  const [commitId, { owner, repo }] = await Promise.all([\n    Git.getHeadCommitId({ dir }),\n    Git.getOwnerAndRepo({ dir }),\n  ]);\n\n  const client = new Octokit({ auth: apiTokenFromEnvironment() });\n\n  await client.checks.create({\n    conclusion,\n    head_sha: commitId,\n    name,\n    output: {\n      annotations: annotations.slice(0, GITHUB_MAX_ANNOTATIONS),\n      summary: createEnrichedSummary(summary, annotations.length),\n      text,\n      title: suffixTitle(title, annotations.length),\n    },\n    owner,\n    repo,\n  });\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAGxB,qBAA0B;AAC1B,UAAqB;AAErB,yBAAwC;AAQxC,MAAM,yBAAyB;AAS/B,MAAM,cAAc,CAAC,OAAe,qBAAqC;AACvE,QAAM,mBACJ,mBAAmB,yBACf,yBACA;AAEN,SAAO,GAAG,KAAK,SAAK,0BAAU,kBAAkB,YAAY,CAAC;AAC/D;AAKA,MAAM,wBAAwB,CAC5B,SACA,qBAEA;AAAA,EACE;AAAA,EACA,GAAI,mBAAmB,yBACnB;AAAA,IACE,GAAG,gBAAgB,kDAAkD,sBAAsB;AAAA,EAC7F,IACA,CAAC;AACP,EAAE,KAAK,MAAM;AA+CR,MAAM,iBAAiB,OAAO;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA+C;AAC7C,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,CAAC,UAAU,EAAE,OAAO,KAAK,CAAC,IAAI,MAAM,QAAQ,IAAI;AAAA,IACpD,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,IAC3B,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,EAC7B,CAAC;AAED,QAAM,SAAS,IAAI,oBAAQ,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAE9D,QAAM,OAAO,OAAO,OAAO;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,IACV;AAAA,IACA,QAAQ;AAAA,MACN,aAAa,YAAY,MAAM,GAAG,sBAAsB;AAAA,MACxD,SAAS,sBAAsB,SAAS,YAAY,MAAM;AAAA,MAC1D;AAAA,MACA,OAAO,YAAY,OAAO,YAAY,MAAM;AAAA,IAC9C;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;",
+  "sourcesContent": ["import type { Endpoints } from '@octokit/types';\n\nimport { pluralise } from '../../utils/logging';\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\nimport { createRestClient } from './octokit';\n\ntype Output = NonNullable<\n  Endpoints['PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}']['parameters']['output']\n>;\n\nexport type Annotation = NonNullable<Output['annotations']>[number];\n\nconst GITHUB_MAX_ANNOTATIONS = 50;\n\n/**\n * Suffixes the title with the number of annotations added, e.g.\n *\n * ```text\n * Build #12 failed (24 annotations added)\n * ```\n */\nconst suffixTitle = (title: string, inputAnnotations: number): string => {\n  const addedAnnotations =\n    inputAnnotations > GITHUB_MAX_ANNOTATIONS\n      ? GITHUB_MAX_ANNOTATIONS\n      : inputAnnotations;\n\n  return `${title} (${pluralise(addedAnnotations, 'annotation')} added)`;\n};\n\n/**\n * Enriches the summary with more context about the check run.\n */\nconst createEnrichedSummary = (\n  summary: string,\n  inputAnnotations: number,\n): string =>\n  [\n    summary,\n    ...(inputAnnotations > GITHUB_MAX_ANNOTATIONS\n      ? [\n          `${inputAnnotations} annotations were provided, but only the first ${GITHUB_MAX_ANNOTATIONS} are visible in GitHub.`,\n        ]\n      : []),\n  ].join('\\n\\n');\n\n/**\n * {@link https://docs.github.com/en/rest/reference/checks#create-a-check-run}\n */\ninterface CreateCheckRunParameters {\n  /**\n   * Adds information from your analysis to specific lines of code.\n   * Annotations are visible on GitHub in the **Checks** and **Files changed**\n   * tab of the pull request.\n   */\n  annotations: Annotation[];\n\n  /**\n   * The final conclusion of the check.\n   */\n  conclusion: 'failure' | 'success';\n\n  /**\n   * The name of the check. For example, \"code-coverage\".\n   */\n  name: string;\n\n  /**\n   * The summary of the check run. This parameter supports Markdown.\n   */\n  summary: string;\n\n  /**\n   * The details of the check run. This parameter supports Markdown.\n   */\n  text?: string;\n\n  /**\n   * The title of the check run.\n   */\n  title: string;\n}\n\n/**\n * Asynchronously creates a GitHub check run with annotations.\n *\n * The first 50 `annotations` are written in full to GitHub.\n *\n * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with the `checks:write` permission\n * must be present on the environment.\n */\nexport const createCheckRun = async ({\n  annotations,\n  conclusion,\n  name,\n  summary,\n  text,\n  title,\n}: CreateCheckRunParameters): Promise<void> => {\n  const dir = process.cwd();\n\n  const [commitId, { owner, repo }] = await Promise.all([\n    Git.getHeadCommitId({ dir }),\n    Git.getOwnerAndRepo({ dir }),\n  ]);\n\n  const client = await createRestClient({ auth: apiTokenFromEnvironment() });\n\n  await client.checks.create({\n    conclusion,\n    head_sha: commitId,\n    name,\n    output: {\n      annotations: annotations.slice(0, GITHUB_MAX_ANNOTATIONS),\n      summary: createEnrichedSummary(summary, annotations.length),\n      text,\n      title: suffixTitle(title, annotations.length),\n    },\n    owner,\n    repo,\n  });\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,qBAA0B;AAC1B,UAAqB;AAErB,yBAAwC;AACxC,qBAAiC;AAQjC,MAAM,yBAAyB;AAS/B,MAAM,cAAc,CAAC,OAAe,qBAAqC;AACvE,QAAM,mBACJ,mBAAmB,yBACf,yBACA;AAEN,SAAO,GAAG,KAAK,SAAK,0BAAU,kBAAkB,YAAY,CAAC;AAC/D;AAKA,MAAM,wBAAwB,CAC5B,SACA,qBAEA;AAAA,EACE;AAAA,EACA,GAAI,mBAAmB,yBACnB;AAAA,IACE,GAAG,gBAAgB,kDAAkD,sBAAsB;AAAA,EAC7F,IACA,CAAC;AACP,EAAE,KAAK,MAAM;AA+CR,MAAM,iBAAiB,OAAO;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA+C;AAC7C,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,CAAC,UAAU,EAAE,OAAO,KAAK,CAAC,IAAI,MAAM,QAAQ,IAAI;AAAA,IACpD,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,IAC3B,IAAI,gBAAgB,EAAE,IAAI,CAAC;AAAA,EAC7B,CAAC;AAED,QAAM,SAAS,UAAM,iCAAiB,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAEzE,QAAM,OAAO,OAAO,OAAO;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,IACV;AAAA,IACA,QAAQ;AAAA,MACN,aAAa,YAAY,MAAM,GAAG,sBAAsB;AAAA,MACxD,SAAS,sBAAsB,SAAS,YAAY,MAAM;AAAA,MAC1D;AAAA,MACA,OAAO,YAAY,OAAO,YAAY,MAAM;AAAA,IAC9C;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;",
   "names": []
 }

package/lib/api/github/issueComment.js

@@ -31,9 +31,9 @@ __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_octokit = require("./octokit");
 var import_pullRequest = require("./pullRequest");
 const getUserId = async (client) => {
   const { data } = await client.users.getAuthenticated();
@@ -43,7 +43,7 @@ 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 client = await (0, import_octokit.createRestClient)({ 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");

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

@@ -1,7 +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   * use `'seek-build-agency'` as an optimisation to skip the user lookup.\n   *\n   * https://api.github.com/users/buildagencygitapitoken[bot]\n   */\n  userId?: number | 'seek-build-agency';\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: number =\n    params.userId === 'seek-build-agency'\n      ? // https://api.github.com/users/buildagencygitapitoken[bot]\n        87109344\n      : 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,SACJ,OAAO,WAAW;AAAA;AAAA,IAEd;AAAA,MACA,OAAO,UAAW,MAAM,UAAU,MAAM;AAE9C,QAAM,YAAY,SAAS,KAAK;AAAA,IAC9B,CAAC,YACC,QAAQ,MAAM,OAAO,WACpB,OAAO,aACJ,QAAQ,MAAM,SAAS;AAAA;AAAA,OAAY,OAAO,UAAU,MAAM,IAC1D;AAAA,EACR,GAAG;AAEH,QAAM,OAAO,OAAO,aAChB,CAAC,OAAO,KAAK,KAAK,GAAG,QAAQ,OAAO,UAAU,MAAM,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;",
+  "sourcesContent": ["import type { Octokit } from '@octokit/rest';\n\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\nimport { createRestClient } from './octokit';\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   * use `'seek-build-agency'` as an optimisation to skip the user lookup.\n   *\n   * https://api.github.com/users/buildagencygitapitoken[bot]\n   */\n  userId?: number | 'seek-build-agency';\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 = await createRestClient({ 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: number =\n    params.userId === 'seek-build-agency'\n      ? // https://api.github.com/users/buildagencygitapitoken[bot]\n        87109344\n      : 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;AAEA,UAAqB;AAErB,yBAAwC;AACxC,qBAAiC;AACjC,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,UAAM,iCAAiB,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAEzE,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,SACJ,OAAO,WAAW;AAAA;AAAA,IAEd;AAAA,MACA,OAAO,UAAW,MAAM,UAAU,MAAM;AAE9C,QAAM,YAAY,SAAS,KAAK;AAAA,IAC9B,CAAC,YACC,QAAQ,MAAM,OAAO,WACpB,OAAO,aACJ,QAAQ,MAAM,SAAS;AAAA;AAAA,OAAY,OAAO,UAAU,MAAM,IAC1D;AAAA,EACR,GAAG;AAEH,QAAM,OAAO,OAAO,aAChB,CAAC,OAAO,KAAK,KAAK,GAAG,QAAQ,OAAO,UAAU,MAAM,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/octokit.d.ts

@@ -1,2 +1,6 @@
+import type { Octokit } from '@octokit/rest';
 import type { RequestParameters } from '@octokit/types';
+export declare const createRestClient: (options: {
+    auth: unknown;
+}) => Promise<Octokit>;
 export declare const graphql: <ResponseData>(query: string, parameters?: RequestParameters) => Promise<ResponseData>;

package/lib/api/github/octokit.js

@@ -28,12 +28,15 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var octokit_exports = {};
 __export(octokit_exports, {
+  createRestClient: () => createRestClient,
   graphql: () => graphql
 });
 module.exports = __toCommonJS(octokit_exports);
+const createRestClient = async (options) => new (await import("@octokit/rest")).Octokit(options);
 const graphql = async (query, parameters) => (await import("@octokit/graphql")).graphql(query, parameters);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createRestClient,
   graphql
 });
 //# sourceMappingURL=octokit.js.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/api/github/octokit.ts"],
-  "sourcesContent": ["import type { RequestParameters } from '@octokit/types';\n\nexport const graphql = async <ResponseData>(\n  query: string,\n  parameters?: RequestParameters,\n) =>\n  (await import('@octokit/graphql')).graphql<ResponseData>(query, parameters);\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEO,MAAM,UAAU,OACrB,OACA,gBAEC,MAAM,OAAO,kBAAkB,GAAG,QAAsB,OAAO,UAAU;",
+  "sourcesContent": ["import type { Octokit } from '@octokit/rest';\nimport type { RequestParameters } from '@octokit/types';\n\nexport const createRestClient = async (options: {\n  auth: unknown;\n}): Promise<Octokit> => new (await import('@octokit/rest')).Octokit(options);\n\nexport const graphql = async <ResponseData>(\n  query: string,\n  parameters?: RequestParameters,\n) =>\n  (await import('@octokit/graphql')).graphql<ResponseData>(query, parameters);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,MAAM,mBAAmB,OAAO,YAEf,KAAK,MAAM,OAAO,eAAe,GAAG,QAAQ,OAAO;AAEpE,MAAM,UAAU,OACrB,OACA,gBAEC,MAAM,OAAO,kBAAkB,GAAG,QAAsB,OAAO,UAAU;",
   "names": []
 }

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

@@ -1,4 +1,4 @@
-import { Octokit } from '@octokit/rest';
+import type { Octokit } from '@octokit/rest';
 interface GetPullRequestParameters {
     /**
      * A preconstructed Octokit client to interact with GitHub's APIs.

package/lib/api/github/pullRequest.js

@@ -31,9 +31,9 @@ __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");
+var import_octokit = require("./octokit");
 const getPullRequestNumber = async (params = {}) => {
   const env = params.env ?? process.env;
   const dir = process.cwd();
@@ -43,7 +43,7 @@ const getPullRequestNumber = async (params = {}) => {
   if (Number.isSafeInteger(number)) {
     return number;
   }
-  const client = params.client ?? new import_rest.Octokit({ auth: (0, import_environment.apiTokenFromEnvironment)() });
+  const client = params.client ?? await (0, import_octokit.createRestClient)({ auth: (0, import_environment.apiTokenFromEnvironment)() });
   const [commitId, { owner, repo }] = await Promise.all([
     Git.getHeadCommitId({ dir, env }),
     Git.getOwnerAndRepo({ dir })

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

@@ -1,7 +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  const pullRequestData = data[0];\n  if (!pullRequestData) {\n    throw new Error(\n      `Commit ${commitId} is not associated with an open GitHub pull request`,\n    );\n  }\n\n  return pullRequestData.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,QAAM,kBAAkB,KAAK,CAAC;AAC9B,MAAI,CAAC,iBAAiB;AACpB,UAAM,IAAI;AAAA,MACR,UAAU,QAAQ;AAAA,IACpB;AAAA,EACF;AAEA,SAAO,gBAAgB;AACzB;",
+  "sourcesContent": ["import type { Octokit } from '@octokit/rest';\n\nimport * as Git from '../git';\n\nimport { apiTokenFromEnvironment } from './environment';\nimport { createRestClient } from './octokit';\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 ??\n    (await createRestClient({ 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  const pullRequestData = data[0];\n  if (!pullRequestData) {\n    throw new Error(\n      `Commit ${commitId} is not associated with an open GitHub pull request`,\n    );\n  }\n\n  return pullRequestData.number;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,UAAqB;AAErB,yBAAwC;AACxC,qBAAiC;AAsB1B,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,UACN,UAAM,iCAAiB,EAAE,UAAM,4CAAwB,EAAE,CAAC;AAE7D,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,QAAM,kBAAkB,KAAK,CAAC;AAC9B,MAAI,CAAC,iBAAiB;AACpB,UAAM,IAAI;AAAA,MACR,UAAU,QAAQ;AAAA,IACpB;AAAA,EACF;AAEA,SAAO,gBAAgB;AACzB;",
   "names": []
 }

package/lib/cli/configure/index.js

@@ -129,7 +129,7 @@ const configure = async () => {
       import_logging.log.warn(import_logging.log.bold("\u2717 Failed to install dependencies. Resume with:"));
       import_logging.log.newline();
       import_logging.log.plain(import_logging.log.bold(packageManager.install));
-      import_logging.log.plain(import_logging.log.bold(packageManager, "format"));
+      import_logging.log.plain(import_logging.log.bold(packageManager.command, "format"));
       import_logging.log.newline();
       process.exitCode = 1;
       return;
@@ -139,7 +139,7 @@ const configure = async () => {
     import_logging.log.newline();
     import_logging.log.ok(import_logging.log.bold("\u2714 All done! Try running:"));
     import_logging.log.newline();
-    import_logging.log.plain(import_logging.log.bold(packageManager, "format"));
+    import_logging.log.plain(import_logging.log.bold(packageManager.command, "format"));
   }
   import_logging.log.newline();
 };

package/lib/cli/configure/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/cli/configure/index.ts"],
-  "sourcesContent": ["import path from 'path';\n\nimport { Select } from 'enquirer';\n\nimport { createInclusionFilter } from '../../utils/dir';\nimport { createExec, ensureCommands } from '../../utils/exec';\nimport { log } from '../../utils/logging';\nimport { showLogoAndVersionInfo } from '../../utils/logo';\nimport { detectPackageManager } from '../../utils/packageManager';\nimport { BASE_TEMPLATE_DIR } from '../../utils/template';\nimport { hasProp } from '../../utils/validation';\n\nimport { analyseConfiguration } from './analyseConfiguration';\nimport { analyseDependencies } from './analyseDependencies';\nimport { auditWorkingTree } from './analysis/git';\nimport { getDestinationManifest } from './analysis/package';\nimport { ensureTemplateCompletion } from './ensureTemplateCompletion';\nimport { getEntryPoint } from './getEntryPoint';\nimport { getProjectType } from './getProjectType';\n\nconst shouldApply = async (name: string) => {\n  if (!process.stdin.isTTY) {\n    return 'yes';\n  }\n  const prompt = new Select({\n    choices: ['yes', 'no'] as const,\n    message: 'Apply changes?',\n    name,\n  });\n\n  const result = await prompt.run();\n\n  return result === 'yes';\n};\n\nexport const configure = async () => {\n  await showLogoAndVersionInfo();\n\n  const [manifest, packageManager] = await Promise.all([\n    getDestinationManifest(),\n    detectPackageManager(),\n  ]);\n\n  await ensureCommands(packageManager.command);\n\n  const destinationRoot = path.dirname(manifest.path);\n\n  log.plain('Detected project root:', log.bold(destinationRoot));\n\n  const [include] = await Promise.all([\n    createInclusionFilter([\n      path.join(destinationRoot, '.gitignore'),\n      path.join(BASE_TEMPLATE_DIR, '_.gitignore'),\n    ]),\n\n    auditWorkingTree(destinationRoot),\n  ]);\n\n  const templateConfig = await ensureTemplateCompletion({\n    destinationRoot,\n    include,\n    manifest,\n  });\n\n  const type = await getProjectType({\n    manifest,\n    templateConfig,\n  });\n\n  const entryPoint = await getEntryPoint({\n    destinationRoot,\n    manifest,\n    templateConfig,\n    type,\n  });\n\n  const fixDependencies = await analyseDependencies({\n    destinationRoot,\n    include,\n    manifest,\n    type,\n  });\n\n  if (fixDependencies) {\n    log.newline();\n\n    if (await shouldApply('fixDependencies')) {\n      await fixDependencies();\n    }\n  }\n\n  const firstRun = hasProp(manifest.packageJson, 'skuba');\n\n  const fixConfiguration = await analyseConfiguration({\n    destinationRoot,\n    entryPoint,\n    firstRun,\n    packageManager,\n    type,\n  });\n\n  if (fixConfiguration) {\n    log.newline();\n\n    if (await shouldApply('fixConfiguration')) {\n      await fixConfiguration();\n    }\n  }\n\n  if (fixDependencies) {\n    const exec = createExec({\n      stdio: 'pipe',\n      streamStdio: packageManager.command,\n    });\n\n    log.newline();\n    try {\n      await exec(packageManager.install);\n    } catch {\n      log.newline();\n      log.warn(log.bold('\u2717 Failed to install dependencies. Resume with:'));\n\n      log.newline();\n      log.plain(log.bold(packageManager.install));\n      log.plain(log.bold(packageManager, 'format'));\n\n      log.newline();\n      process.exitCode = 1;\n      return;\n    }\n  }\n\n  if (fixConfiguration ?? fixDependencies) {\n    log.newline();\n    log.ok(log.bold('\u2714 All done! Try running:'));\n\n    log.newline();\n    log.plain(log.bold(packageManager, 'format'));\n  }\n\n  log.newline();\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAuB;AAEvB,iBAAsC;AACtC,kBAA2C;AAC3C,qBAAoB;AACpB,kBAAuC;AACvC,4BAAqC;AACrC,sBAAkC;AAClC,wBAAwB;AAExB,kCAAqC;AACrC,iCAAoC;AACpC,iBAAiC;AACjC,qBAAuC;AACvC,sCAAyC;AACzC,2BAA8B;AAC9B,4BAA+B;AAE/B,MAAM,cAAc,OAAO,SAAiB;AAC1C,MAAI,CAAC,QAAQ,MAAM,OAAO;AACxB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,IAAI,uBAAO;AAAA,IACxB,SAAS,CAAC,OAAO,IAAI;AAAA,IACrB,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAED,QAAM,SAAS,MAAM,OAAO,IAAI;AAEhC,SAAO,WAAW;AACpB;AAEO,MAAM,YAAY,YAAY;AACnC,YAAM,oCAAuB;AAE7B,QAAM,CAAC,UAAU,cAAc,IAAI,MAAM,QAAQ,IAAI;AAAA,QACnD,uCAAuB;AAAA,QACvB,4CAAqB;AAAA,EACvB,CAAC;AAED,YAAM,4BAAe,eAAe,OAAO;AAE3C,QAAM,kBAAkB,YAAAA,QAAK,QAAQ,SAAS,IAAI;AAElD,qBAAI,MAAM,0BAA0B,mBAAI,KAAK,eAAe,CAAC;AAE7D,QAAM,CAAC,OAAO,IAAI,MAAM,QAAQ,IAAI;AAAA,QAClC,kCAAsB;AAAA,MACpB,YAAAA,QAAK,KAAK,iBAAiB,YAAY;AAAA,MACvC,YAAAA,QAAK,KAAK,mCAAmB,aAAa;AAAA,IAC5C,CAAC;AAAA,QAED,6BAAiB,eAAe;AAAA,EAClC,CAAC;AAED,QAAM,iBAAiB,UAAM,0DAAyB;AAAA,IACpD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,OAAO,UAAM,sCAAe;AAAA,IAChC;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,aAAa,UAAM,oCAAc;AAAA,IACrC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,kBAAkB,UAAM,gDAAoB;AAAA,IAChD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,MAAI,iBAAiB;AACnB,uBAAI,QAAQ;AAEZ,QAAI,MAAM,YAAY,iBAAiB,GAAG;AACxC,YAAM,gBAAgB;AAAA,IACxB;AAAA,EACF;AAEA,QAAM,eAAW,2BAAQ,SAAS,aAAa,OAAO;AAEtD,QAAM,mBAAmB,UAAM,kDAAqB;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,MAAI,kBAAkB;AACpB,uBAAI,QAAQ;AAEZ,QAAI,MAAM,YAAY,kBAAkB,GAAG;AACzC,YAAM,iBAAiB;AAAA,IACzB;AAAA,EACF;AAEA,MAAI,iBAAiB;AACnB,UAAM,WAAO,wBAAW;AAAA,MACtB,OAAO;AAAA,MACP,aAAa,eAAe;AAAA,IAC9B,CAAC;AAED,uBAAI,QAAQ;AACZ,QAAI;AACF,YAAM,KAAK,eAAe,OAAO;AAAA,IACnC,QAAQ;AACN,yBAAI,QAAQ;AACZ,yBAAI,KAAK,mBAAI,KAAK,qDAAgD,CAAC;AAEnE,yBAAI,QAAQ;AACZ,yBAAI,MAAM,mBAAI,KAAK,eAAe,OAAO,CAAC;AAC1C,yBAAI,MAAM,mBAAI,KAAK,gBAAgB,QAAQ,CAAC;AAE5C,yBAAI,QAAQ;AACZ,cAAQ,WAAW;AACnB;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oBAAoB,iBAAiB;AACvC,uBAAI,QAAQ;AACZ,uBAAI,GAAG,mBAAI,KAAK,+BAA0B,CAAC;AAE3C,uBAAI,QAAQ;AACZ,uBAAI,MAAM,mBAAI,KAAK,gBAAgB,QAAQ,CAAC;AAAA,EAC9C;AAEA,qBAAI,QAAQ;AACd;",
+  "sourcesContent": ["import path from 'path';\n\nimport { Select } from 'enquirer';\n\nimport { createInclusionFilter } from '../../utils/dir';\nimport { createExec, ensureCommands } from '../../utils/exec';\nimport { log } from '../../utils/logging';\nimport { showLogoAndVersionInfo } from '../../utils/logo';\nimport { detectPackageManager } from '../../utils/packageManager';\nimport { BASE_TEMPLATE_DIR } from '../../utils/template';\nimport { hasProp } from '../../utils/validation';\n\nimport { analyseConfiguration } from './analyseConfiguration';\nimport { analyseDependencies } from './analyseDependencies';\nimport { auditWorkingTree } from './analysis/git';\nimport { getDestinationManifest } from './analysis/package';\nimport { ensureTemplateCompletion } from './ensureTemplateCompletion';\nimport { getEntryPoint } from './getEntryPoint';\nimport { getProjectType } from './getProjectType';\n\nconst shouldApply = async (name: string) => {\n  if (!process.stdin.isTTY) {\n    return 'yes';\n  }\n  const prompt = new Select({\n    choices: ['yes', 'no'] as const,\n    message: 'Apply changes?',\n    name,\n  });\n\n  const result = await prompt.run();\n\n  return result === 'yes';\n};\n\nexport const configure = async () => {\n  await showLogoAndVersionInfo();\n\n  const [manifest, packageManager] = await Promise.all([\n    getDestinationManifest(),\n    detectPackageManager(),\n  ]);\n\n  await ensureCommands(packageManager.command);\n\n  const destinationRoot = path.dirname(manifest.path);\n\n  log.plain('Detected project root:', log.bold(destinationRoot));\n\n  const [include] = await Promise.all([\n    createInclusionFilter([\n      path.join(destinationRoot, '.gitignore'),\n      path.join(BASE_TEMPLATE_DIR, '_.gitignore'),\n    ]),\n\n    auditWorkingTree(destinationRoot),\n  ]);\n\n  const templateConfig = await ensureTemplateCompletion({\n    destinationRoot,\n    include,\n    manifest,\n  });\n\n  const type = await getProjectType({\n    manifest,\n    templateConfig,\n  });\n\n  const entryPoint = await getEntryPoint({\n    destinationRoot,\n    manifest,\n    templateConfig,\n    type,\n  });\n\n  const fixDependencies = await analyseDependencies({\n    destinationRoot,\n    include,\n    manifest,\n    type,\n  });\n\n  if (fixDependencies) {\n    log.newline();\n\n    if (await shouldApply('fixDependencies')) {\n      await fixDependencies();\n    }\n  }\n\n  const firstRun = hasProp(manifest.packageJson, 'skuba');\n\n  const fixConfiguration = await analyseConfiguration({\n    destinationRoot,\n    entryPoint,\n    firstRun,\n    packageManager,\n    type,\n  });\n\n  if (fixConfiguration) {\n    log.newline();\n\n    if (await shouldApply('fixConfiguration')) {\n      await fixConfiguration();\n    }\n  }\n\n  if (fixDependencies) {\n    const exec = createExec({\n      stdio: 'pipe',\n      streamStdio: packageManager.command,\n    });\n\n    log.newline();\n    try {\n      await exec(packageManager.install);\n    } catch {\n      log.newline();\n      log.warn(log.bold('\u2717 Failed to install dependencies. Resume with:'));\n\n      log.newline();\n      log.plain(log.bold(packageManager.install));\n      log.plain(log.bold(packageManager.command, 'format'));\n\n      log.newline();\n      process.exitCode = 1;\n      return;\n    }\n  }\n\n  if (fixConfiguration ?? fixDependencies) {\n    log.newline();\n    log.ok(log.bold('\u2714 All done! Try running:'));\n\n    log.newline();\n    log.plain(log.bold(packageManager.command, 'format'));\n  }\n\n  log.newline();\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAuB;AAEvB,iBAAsC;AACtC,kBAA2C;AAC3C,qBAAoB;AACpB,kBAAuC;AACvC,4BAAqC;AACrC,sBAAkC;AAClC,wBAAwB;AAExB,kCAAqC;AACrC,iCAAoC;AACpC,iBAAiC;AACjC,qBAAuC;AACvC,sCAAyC;AACzC,2BAA8B;AAC9B,4BAA+B;AAE/B,MAAM,cAAc,OAAO,SAAiB;AAC1C,MAAI,CAAC,QAAQ,MAAM,OAAO;AACxB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,IAAI,uBAAO;AAAA,IACxB,SAAS,CAAC,OAAO,IAAI;AAAA,IACrB,SAAS;AAAA,IACT;AAAA,EACF,CAAC;AAED,QAAM,SAAS,MAAM,OAAO,IAAI;AAEhC,SAAO,WAAW;AACpB;AAEO,MAAM,YAAY,YAAY;AACnC,YAAM,oCAAuB;AAE7B,QAAM,CAAC,UAAU,cAAc,IAAI,MAAM,QAAQ,IAAI;AAAA,QACnD,uCAAuB;AAAA,QACvB,4CAAqB;AAAA,EACvB,CAAC;AAED,YAAM,4BAAe,eAAe,OAAO;AAE3C,QAAM,kBAAkB,YAAAA,QAAK,QAAQ,SAAS,IAAI;AAElD,qBAAI,MAAM,0BAA0B,mBAAI,KAAK,eAAe,CAAC;AAE7D,QAAM,CAAC,OAAO,IAAI,MAAM,QAAQ,IAAI;AAAA,QAClC,kCAAsB;AAAA,MACpB,YAAAA,QAAK,KAAK,iBAAiB,YAAY;AAAA,MACvC,YAAAA,QAAK,KAAK,mCAAmB,aAAa;AAAA,IAC5C,CAAC;AAAA,QAED,6BAAiB,eAAe;AAAA,EAClC,CAAC;AAED,QAAM,iBAAiB,UAAM,0DAAyB;AAAA,IACpD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,OAAO,UAAM,sCAAe;AAAA,IAChC;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,aAAa,UAAM,oCAAc;AAAA,IACrC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,kBAAkB,UAAM,gDAAoB;AAAA,IAChD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,MAAI,iBAAiB;AACnB,uBAAI,QAAQ;AAEZ,QAAI,MAAM,YAAY,iBAAiB,GAAG;AACxC,YAAM,gBAAgB;AAAA,IACxB;AAAA,EACF;AAEA,QAAM,eAAW,2BAAQ,SAAS,aAAa,OAAO;AAEtD,QAAM,mBAAmB,UAAM,kDAAqB;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,MAAI,kBAAkB;AACpB,uBAAI,QAAQ;AAEZ,QAAI,MAAM,YAAY,kBAAkB,GAAG;AACzC,YAAM,iBAAiB;AAAA,IACzB;AAAA,EACF;AAEA,MAAI,iBAAiB;AACnB,UAAM,WAAO,wBAAW;AAAA,MACtB,OAAO;AAAA,MACP,aAAa,eAAe;AAAA,IAC9B,CAAC;AAED,uBAAI,QAAQ;AACZ,QAAI;AACF,YAAM,KAAK,eAAe,OAAO;AAAA,IACnC,QAAQ;AACN,yBAAI,QAAQ;AACZ,yBAAI,KAAK,mBAAI,KAAK,qDAAgD,CAAC;AAEnE,yBAAI,QAAQ;AACZ,yBAAI,MAAM,mBAAI,KAAK,eAAe,OAAO,CAAC;AAC1C,yBAAI,MAAM,mBAAI,KAAK,eAAe,SAAS,QAAQ,CAAC;AAEpD,yBAAI,QAAQ;AACZ,cAAQ,WAAW;AACnB;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oBAAoB,iBAAiB;AACvC,uBAAI,QAAQ;AACZ,uBAAI,GAAG,mBAAI,KAAK,+BAA0B,CAAC;AAE3C,uBAAI,QAAQ;AACZ,uBAAI,MAAM,mBAAI,KAAK,eAAe,SAAS,QAAQ,CAAC;AAAA,EACtD;AAEA,qBAAI,QAAQ;AACd;",
   "names": ["path"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -54,7 +54,7 @@
     "@jest/types": "^29.0.0",
     "@octokit/graphql": "^8.0.0",
     "@octokit/graphql-schema": "^15.3.0",
-    "@octokit/rest": "^20.0.0",
+    "@octokit/rest": "^21.0.0",
     "@octokit/types": "^13.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": ">=18.12",

package/template/base/_.gitignore

@@ -6,6 +6,7 @@
 .cdk.staging/
 .serverless/
 cdk.out/
+cdk.context.json
 node_modules*/
 
 /coverage*/

package/template/base/_.npmrc

@@ -1,4 +1,5 @@
 # managed by skuba
+package-manager-strict-version=true
 public-hoist-pattern[]="@types*"
 public-hoist-pattern[]="*eslint*"
 public-hoist-pattern[]="*prettier*"

package/template/express-rest-api/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/express-rest-api/README.md

@@ -12,15 +12,15 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
        see the [Gantry] documentation for more information.
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/greeter/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/greeter/README.md

@@ -12,13 +12,13 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Push local commits to the upstream GitHub branch.
 5. [ ] Configure [GitHub repository settings].
 6. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/koa-rest-api/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/koa-rest-api/README.md

@@ -12,15 +12,15 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog configuration and data classification tags to [.gantry/common.yml](.gantry/common.yml);
        see the [Gantry] documentation for more information.
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/koa-rest-api/src/api/jobs/index.ts

@@ -1,6 +1,6 @@
 import Router from '@koa/router';
 
-import { jsonBodyParser } from 'src/framework/middleware';
+import { jsonBodyParser } from 'src/framework/bodyParser';
 
 import { getJobsHandler } from './getJobs';
 import { postJobHandler } from './postJob';

package/template/koa-rest-api/src/app.test.ts

@@ -10,16 +10,11 @@ describe('app', () => {
 
   it('has a happy health check', () => agent.get('/health').expect(200, ''));
 
-  it('has a reachable smoke test', async () => {
-    const response = await agent.get('/smoke');
-    expect(response.status).not.toBe(404);
-  });
+  it('has a reachable smoke test', () =>
+    agent.options('/smoke').expect(200, '').expect('Allow', 'HEAD, GET'));
 
-  it('has a reachable nested route', async () => {
-    const response = await agent.get('/jobs');
-    expect(response.status).not.toBe(404);
-  });
+  it('has a reachable nested route', () =>
+    agent.options('/jobs').expect(200, '').expect('Allow', /POST/));
 
-  it('has OPTIONS for a nested route', () =>
-    agent.options('/jobs').expect(200).expect('allow', /HEAD/));
+  it('handles an unknown route', () => agent.options('/admin.php').expect(404));
 });

package/template/koa-rest-api/src/framework/validation.test.ts

@@ -5,7 +5,7 @@ import {
   mockIdDescription,
 } from 'src/testing/types';
 
-import { jsonBodyParser } from './middleware';
+import { jsonBodyParser } from './bodyParser';
 import { validate } from './validation';
 
 const agent = agentFromMiddleware(jsonBodyParser, (ctx) => {

package/template/lambda-sqs-worker/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/lambda-sqs-worker/README.md

@@ -12,14 +12,14 @@ Next steps:
 
 2. [ ] Create a new repository in the appropriate GitHub organisation.
 3. [ ] Add the repository to BuildAgency;
-       see [Builds at SEEK] for more information.
+       see our internal [Buildkite Docs] for more information.
 4. [ ] Add Datadog extension, deployment bucket configuration and data classification tags to [serverless.yml](serverless.yml).
 5. [ ] Push local commits to the upstream GitHub branch.
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Buildkite Docs]: https://backstage.myseek.xyz/docs/default/component/buildkite-docs
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 

package/template/lambda-sqs-worker/_.npmrc

@@ -1,4 +1,5 @@
 # managed by skuba
+package-manager-strict-version=true
 public-hoist-pattern[]="@types*"
 public-hoist-pattern[]="*eslint*"
 public-hoist-pattern[]="*prettier*"

package/template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: <%- prodBuildkiteQueueName %>
 

package/template/lambda-sqs-worker-cdk/infra/__snapshots__/appStack.test.ts.snap

@@ -37,9 +37,18 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "ap-southeast-4": {
         "codedeploy": "codedeploy.ap-southeast-4.amazonaws.com",
       },
+      "ap-southeast-5": {
+        "codedeploy": "codedeploy.ap-southeast-5.amazonaws.com",
+      },
+      "ap-southeast-7": {
+        "codedeploy": "codedeploy.ap-southeast-7.amazonaws.com",
+      },
       "ca-central-1": {
         "codedeploy": "codedeploy.ca-central-1.amazonaws.com",
       },
+      "ca-west-1": {
+        "codedeploy": "codedeploy.ca-west-1.amazonaws.com",
+      },
       "cn-north-1": {
         "codedeploy": "codedeploy.cn-north-1.amazonaws.com.cn",
       },
@@ -52,6 +61,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "eu-central-2": {
         "codedeploy": "codedeploy.eu-central-2.amazonaws.com",
       },
+      "eu-isoe-west-1": {
+        "codedeploy": "codedeploy.eu-isoe-west-1.amazonaws.com",
+      },
       "eu-north-1": {
         "codedeploy": "codedeploy.eu-north-1.amazonaws.com",
       },
@@ -79,6 +91,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
       "me-south-1": {
         "codedeploy": "codedeploy.me-south-1.amazonaws.com",
       },
+      "mx-central-1": {
+        "codedeploy": "codedeploy.mx-central-1.amazonaws.com",
+      },
       "sa-east-1": {
         "codedeploy": "codedeploy.sa-east-1.amazonaws.com",
       },
@@ -1085,9 +1100,18 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "ap-southeast-4": {
         "codedeploy": "codedeploy.ap-southeast-4.amazonaws.com",
       },
+      "ap-southeast-5": {
+        "codedeploy": "codedeploy.ap-southeast-5.amazonaws.com",
+      },
+      "ap-southeast-7": {
+        "codedeploy": "codedeploy.ap-southeast-7.amazonaws.com",
+      },
       "ca-central-1": {
         "codedeploy": "codedeploy.ca-central-1.amazonaws.com",
       },
+      "ca-west-1": {
+        "codedeploy": "codedeploy.ca-west-1.amazonaws.com",
+      },
       "cn-north-1": {
         "codedeploy": "codedeploy.cn-north-1.amazonaws.com.cn",
       },
@@ -1100,6 +1124,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "eu-central-2": {
         "codedeploy": "codedeploy.eu-central-2.amazonaws.com",
       },
+      "eu-isoe-west-1": {
+        "codedeploy": "codedeploy.eu-isoe-west-1.amazonaws.com",
+      },
       "eu-north-1": {
         "codedeploy": "codedeploy.eu-north-1.amazonaws.com",
       },
@@ -1127,6 +1154,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
       "me-south-1": {
         "codedeploy": "codedeploy.me-south-1.amazonaws.com",
       },
+      "mx-central-1": {
+        "codedeploy": "codedeploy.mx-central-1.amazonaws.com",
+      },
       "sa-east-1": {
         "codedeploy": "codedeploy.sa-east-1.amazonaws.com",
       },

package/template/oss-npm-package/README.md

@@ -17,9 +17,9 @@ Next steps:
 6. [ ] Delete this checklist 😌.
 
 [#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
-[renovate]: https://github.com/apps/renovate
-[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[Renovate]: https://github.com/apps/renovate
+[SEEK's Open Source RFC]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
 
 ## API
 

package/template/private-npm-package/.buildkite/pipeline.yml

@@ -1,3 +1,4 @@
+$schema: https://raw.githubusercontent.com/buildkite/pipeline-schema/main/schema.json
 agents:
   queue: artefacts:npm2
 

package/template/private-npm-package/README.md

@@ -14,7 +14,7 @@ Next steps:
 4. [ ] Configure [GitHub repository settings].
 5. [ ] Delete this checklist 😌.
 
-[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[GitHub repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 [installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
 
 ## API