skuba 7.5.0 → 7.5.2-jest-node-next-20240319045958

package/jest/transform.js

@@ -40,7 +40,7 @@ module.exports.transform = Object.fromEntries(
               ...value[1],
               isolatedModules:
                 value[1]?.isolatedModules ??
-                maybeTsConfig?.isolatedModules ??
+                maybeTsConfig?.options.isolatedModules ??
                 true,
             },
           ]

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

@@ -35,11 +35,11 @@ interface PutIssueCommentParameters {
      * 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.
+     * use `'seek-build-agency'` as an optimisation to skip the user lookup.
      *
      * https://api.github.com/users/buildagencygitapitoken[bot]
      */
-    userId?: number;
+    userId?: number | 'seek-build-agency';
 }
 interface IssueComment {
     id: number;

package/lib/api/github/issueComment.js

@@ -53,7 +53,10 @@ const putIssueComment = async (params) => {
     owner,
     repo
   });
-  const userId = params.userId ?? await getUserId(client);
+  const userId = params.userId === "seek-build-agency" ? (
+    // https://api.github.com/users/buildagencygitapitoken[bot]
+    87109344
+  ) : params.userId ?? await getUserId(client);
   const commentId = comments.data.find(
     (comment) => comment.user?.id === userId && (params.internalId ? comment.body?.endsWith(`
 

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   * 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,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 { 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;",
   "names": []
 }

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

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

package/lib/api/github/octokit.js

@@ -0,0 +1,39 @@
+"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 octokit_exports = {};
+__export(octokit_exports, {
+  graphql: () => graphql
+});
+module.exports = __toCommonJS(octokit_exports);
+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 = {
+  graphql
+});
+//# sourceMappingURL=octokit.js.map

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

@@ -0,0 +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;",
+  "names": []
+}

package/lib/api/github/push.js

@@ -34,10 +34,10 @@ __export(push_exports, {
 });
 module.exports = __toCommonJS(push_exports);
 var import_path = __toESM(require("path"));
-var import_graphql = require("@octokit/graphql");
 var import_fs_extra = __toESM(require("fs-extra"));
 var Git = __toESM(require("../git"));
 var import_environment = require("./environment");
+var import_octokit = require("./octokit");
 const uploadAllFileChanges = async ({
   branch,
   dir,
@@ -139,7 +139,7 @@ const uploadFileChanges = async ({
     clientMutationId: "skuba",
     fileChanges
   };
-  const result = await (0, import_graphql.graphql)(
+  const result = await (0, import_octokit.graphql)(
     `
       mutation Mutation($input: CreateCommitOnBranchInput!) {
         createCommitOnBranch(input: $input) {

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/api/github/push.ts"],
-  "sourcesContent": ["import path from 'path';\n\nimport { 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(dir, 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  dir: string,\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 gitRoot = await Git.findRoot({ dir });\n\n  const toGitHubPath = (filePath: string) => {\n    if (!gitRoot) {\n      return filePath;\n    }\n\n    const pathDir = path.relative(gitRoot, dir);\n\n    return path.join(pathDir, filePath);\n  };\n\n  const additions: FileAddition[] = await Promise.all(\n    added.map(async (filePath) => ({\n      path: toGitHubPath(filePath),\n      contents: await fs.promises.readFile(filePath, {\n        encoding: 'base64',\n      }),\n    })),\n  );\n\n  const deletions: FileDeletion[] = deleted.map((filePath) => ({\n    path: toGitHubPath(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,kBAAiB;AAEjB,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,KAAK,YAAY;AAE3D,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,KACA,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,UAAU,MAAM,IAAI,SAAS,EAAE,IAAI,CAAC;AAE1C,QAAM,eAAe,CAAC,aAAqB;AACzC,QAAI,CAAC,SAAS;AACZ,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,YAAAC,QAAK,SAAS,SAAS,GAAG;AAE1C,WAAO,YAAAA,QAAK,KAAK,SAAS,QAAQ;AAAA,EACpC;AAEA,QAAM,YAA4B,MAAM,QAAQ;AAAA,IAC9C,MAAM,IAAI,OAAO,cAAc;AAAA,MAC7B,MAAM,aAAa,QAAQ;AAAA,MAC3B,UAAU,MAAM,gBAAAD,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,QAAQ;AAAA,EAC7B,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,KAAK,IAAI,IAAI;AAAA,MACzC,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,SAAS;AAAA,MACpC;AAAA,IACF;AAAA,EACF;AAEA,SAAO,OAAO,qBAAqB,OAAO;AAC5C;",
+  "sourcesContent": ["import path from 'path';\n\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';\nimport { graphql } from './octokit';\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(dir, 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  dir: string,\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 gitRoot = await Git.findRoot({ dir });\n\n  const toGitHubPath = (filePath: string) => {\n    if (!gitRoot) {\n      return filePath;\n    }\n\n    const pathDir = path.relative(gitRoot, dir);\n\n    return path.join(pathDir, filePath);\n  };\n\n  const additions: FileAddition[] = await Promise.all(\n    added.map(async (filePath) => ({\n      path: toGitHubPath(filePath),\n      contents: await fs.promises.readFile(filePath, {\n        encoding: 'base64',\n      }),\n    })),\n  );\n\n  const deletions: FileDeletion[] = deleted.map((filePath) => ({\n    path: toGitHubPath(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,kBAAiB;AAOjB,sBAAe;AAEf,UAAqB;AAErB,yBAAwC;AACxC,qBAAwB;AAiDjB,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,KAAK,YAAY;AAE3D,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,KACA,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,UAAU,MAAM,IAAI,SAAS,EAAE,IAAI,CAAC;AAE1C,QAAM,eAAe,CAAC,aAAqB;AACzC,QAAI,CAAC,SAAS;AACZ,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,YAAAC,QAAK,SAAS,SAAS,GAAG;AAE1C,WAAO,YAAAA,QAAK,KAAK,SAAS,QAAQ;AAAA,EACpC;AAEA,QAAM,YAA4B,MAAM,QAAQ;AAAA,IAC9C,MAAM,IAAI,OAAO,cAAc;AAAA,MAC7B,MAAM,aAAa,QAAQ;AAAA,MAC3B,UAAU,MAAM,gBAAAD,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,QAAQ;AAAA,EAC7B,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,KAAK,IAAI,IAAI;AAAA,MACzC,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,SAAS;AAAA,MACpC;AAAA,IACF;AAAA,EACF;AAEA,SAAO,OAAO,qBAAqB,OAAO;AAC5C;",
   "names": ["fs", "path"]
 }

package/lib/skuba.d.ts

@@ -1,2 +1,11 @@
 #!/usr/bin/env node
+/**
+ * Entry point for the CLI.
+ *
+ * This is where you end up when you run:
+ *
+ * ```bash
+ * [pnpm|yarn] skuba help
+ * ```
+ */
 export {};

package/lib/skuba.js

@@ -22,7 +22,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
-var import_why_is_node_running = __toESM(require("why-is-node-running"));
 var import_path = __toESM(require("path"));
 var import_args = require("./utils/args");
 var import_command = require("./utils/command");
@@ -56,7 +55,6 @@ const skuba = async () => {
           import_logging.log.bold(commandName),
           "timed out. This may indicate a process hanging - please file an issue."
         );
-        (0, import_why_is_node_running.default)();
         process.exit(1);
       },
       process.env.SKUBA_TIMEOUT_MS ? parseInt(process.env.SKUBA_TIMEOUT_MS, 10) : THIRTY_MINUTES

package/lib/skuba.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/skuba.ts"],
-  "sourcesContent": ["#!/usr/bin/env node\n\nimport whyIsNodeRunning from 'why-is-node-running';\n\n/**\n * Entry point for the CLI.\n *\n * This is where you end up when you run:\n *\n * ```bash\n * [pnpm|yarn] skuba help\n * ```\n */\n\n// eslint-disable-next-line import/order -- why-is-node-running must be imported before anything else\nimport path from 'path';\n\nimport { parseProcessArgs } from './utils/args';\nimport {\n  COMMAND_DIR,\n  COMMAND_SET,\n  type Command,\n  commandToModule,\n} from './utils/command';\nimport { isCiEnv } from './utils/env';\nimport { handleCliError } from './utils/error';\nimport { showHelp } from './utils/help';\nimport { log } from './utils/logging';\nimport { showLogoAndVersionInfo } from './utils/logo';\nimport { hasProp } from './utils/validation';\n\nconst THIRTY_MINUTES = 30 * 60 * 1000;\n\nconst skuba = async () => {\n  const { commandName } = parseProcessArgs(process.argv);\n\n  if (COMMAND_SET.has(commandName)) {\n    const moduleName = commandToModule(commandName as Command);\n\n    /* eslint-disable @typescript-eslint/no-var-requires */\n    const commandModule = require(\n      path.join(COMMAND_DIR, moduleName),\n    ) as unknown;\n\n    if (!hasProp(commandModule, moduleName)) {\n      log.err(log.bold(commandName), \"couldn't run! Please submit an issue.\");\n      process.exitCode = 1;\n      return;\n    }\n\n    const run = commandModule[moduleName] as () => Promise<unknown>;\n\n    if (commandModule.longRunning) {\n      // This is a long-running command, so we don't want to impose a timeout.\n      return run();\n    }\n\n    // If we're not in a CI environment, we don't need to worry about timeouts, which are primarily to prevent\n    // builds running \"forever\" in CI without our knowledge.\n    // Local commands may run for a long time, e.g. `skuba start` or `skuba test --watch`, which are unlikely to be used in CI.\n    if (!isCiEnv() || process.env.SKUBA_NO_TIMEOUT === 'true') {\n      return run();\n    }\n\n    const timeoutId = setTimeout(\n      () => {\n        log.err(\n          log.bold(commandName),\n          'timed out. This may indicate a process hanging - please file an issue.',\n        );\n        whyIsNodeRunning();\n        // Need to force exit because promises may be hanging so node won't exit on its own.\n        process.exit(1);\n      },\n      process.env.SKUBA_TIMEOUT_MS\n        ? parseInt(process.env.SKUBA_TIMEOUT_MS, 10)\n        : THIRTY_MINUTES,\n    );\n\n    return run().finally(() => clearTimeout(timeoutId));\n  }\n\n  log.err(log.bold(commandName), 'is not recognised as a command.');\n  await showLogoAndVersionInfo();\n  showHelp();\n\n  process.exitCode = 1;\n  return;\n};\n\nskuba().catch(handleCliError);\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAEA,iCAA6B;AAa7B,kBAAiB;AAEjB,kBAAiC;AACjC,qBAKO;AACP,iBAAwB;AACxB,mBAA+B;AAC/B,kBAAyB;AACzB,qBAAoB;AACpB,kBAAuC;AACvC,wBAAwB;AAExB,MAAM,iBAAiB,KAAK,KAAK;AAEjC,MAAM,QAAQ,YAAY;AACxB,QAAM,EAAE,YAAY,QAAI,8BAAiB,QAAQ,IAAI;AAErD,MAAI,2BAAY,IAAI,WAAW,GAAG;AAChC,UAAM,iBAAa,gCAAgB,WAAsB;AAGzD,UAAM,gBAAgB,QACpB,YAAAA,QAAK,KAAK,4BAAa,UAAU,CACnC;AAEA,QAAI,KAAC,2BAAQ,eAAe,UAAU,GAAG;AACvC,yBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,uCAAuC;AACtE,cAAQ,WAAW;AACnB;AAAA,IACF;AAEA,UAAM,MAAM,cAAc,UAAU;AAEpC,QAAI,cAAc,aAAa;AAE7B,aAAO,IAAI;AAAA,IACb;AAKA,QAAI,KAAC,oBAAQ,KAAK,QAAQ,IAAI,qBAAqB,QAAQ;AACzD,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,YAAY;AAAA,MAChB,MAAM;AACJ,2BAAI;AAAA,UACF,mBAAI,KAAK,WAAW;AAAA,UACpB;AAAA,QACF;AACA,uCAAAC,SAAiB;AAEjB,gBAAQ,KAAK,CAAC;AAAA,MAChB;AAAA,MACA,QAAQ,IAAI,mBACR,SAAS,QAAQ,IAAI,kBAAkB,EAAE,IACzC;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,QAAQ,MAAM,aAAa,SAAS,CAAC;AAAA,EACpD;AAEA,qBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,iCAAiC;AAChE,YAAM,oCAAuB;AAC7B,4BAAS;AAET,UAAQ,WAAW;AACnB;AACF;AAEA,MAAM,EAAE,MAAM,2BAAc;",
-  "names": ["path", "whyIsNodeRunning"]
+  "sourcesContent": ["#!/usr/bin/env node\n\n/**\n * Entry point for the CLI.\n *\n * This is where you end up when you run:\n *\n * ```bash\n * [pnpm|yarn] skuba help\n * ```\n */\n\nimport path from 'path';\n\nimport { parseProcessArgs } from './utils/args';\nimport {\n  COMMAND_DIR,\n  COMMAND_SET,\n  type Command,\n  commandToModule,\n} from './utils/command';\nimport { isCiEnv } from './utils/env';\nimport { handleCliError } from './utils/error';\nimport { showHelp } from './utils/help';\nimport { log } from './utils/logging';\nimport { showLogoAndVersionInfo } from './utils/logo';\nimport { hasProp } from './utils/validation';\n\nconst THIRTY_MINUTES = 30 * 60 * 1000;\n\nconst skuba = async () => {\n  const { commandName } = parseProcessArgs(process.argv);\n\n  if (COMMAND_SET.has(commandName)) {\n    const moduleName = commandToModule(commandName as Command);\n\n    /* eslint-disable @typescript-eslint/no-var-requires */\n    const commandModule = require(\n      path.join(COMMAND_DIR, moduleName),\n    ) as unknown;\n\n    if (!hasProp(commandModule, moduleName)) {\n      log.err(log.bold(commandName), \"couldn't run! Please submit an issue.\");\n      process.exitCode = 1;\n      return;\n    }\n\n    const run = commandModule[moduleName] as () => Promise<unknown>;\n\n    if (commandModule.longRunning) {\n      // This is a long-running command, so we don't want to impose a timeout.\n      return run();\n    }\n\n    // If we're not in a CI environment, we don't need to worry about timeouts, which are primarily to prevent\n    // builds running \"forever\" in CI without our knowledge.\n    // Local commands may run for a long time, e.g. `skuba start` or `skuba test --watch`, which are unlikely to be used in CI.\n    if (!isCiEnv() || process.env.SKUBA_NO_TIMEOUT === 'true') {\n      return run();\n    }\n\n    const timeoutId = setTimeout(\n      () => {\n        log.err(\n          log.bold(commandName),\n          'timed out. This may indicate a process hanging - please file an issue.',\n        );\n\n        // Need to force exit because promises may be hanging so node won't exit on its own.\n        process.exit(1);\n      },\n      process.env.SKUBA_TIMEOUT_MS\n        ? parseInt(process.env.SKUBA_TIMEOUT_MS, 10)\n        : THIRTY_MINUTES,\n    );\n\n    return run().finally(() => clearTimeout(timeoutId));\n  }\n\n  log.err(log.bold(commandName), 'is not recognised as a command.');\n  await showLogoAndVersionInfo();\n  showHelp();\n\n  process.exitCode = 1;\n  return;\n};\n\nskuba().catch(handleCliError);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAYA,kBAAiB;AAEjB,kBAAiC;AACjC,qBAKO;AACP,iBAAwB;AACxB,mBAA+B;AAC/B,kBAAyB;AACzB,qBAAoB;AACpB,kBAAuC;AACvC,wBAAwB;AAExB,MAAM,iBAAiB,KAAK,KAAK;AAEjC,MAAM,QAAQ,YAAY;AACxB,QAAM,EAAE,YAAY,QAAI,8BAAiB,QAAQ,IAAI;AAErD,MAAI,2BAAY,IAAI,WAAW,GAAG;AAChC,UAAM,iBAAa,gCAAgB,WAAsB;AAGzD,UAAM,gBAAgB,QACpB,YAAAA,QAAK,KAAK,4BAAa,UAAU,CACnC;AAEA,QAAI,KAAC,2BAAQ,eAAe,UAAU,GAAG;AACvC,yBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,uCAAuC;AACtE,cAAQ,WAAW;AACnB;AAAA,IACF;AAEA,UAAM,MAAM,cAAc,UAAU;AAEpC,QAAI,cAAc,aAAa;AAE7B,aAAO,IAAI;AAAA,IACb;AAKA,QAAI,KAAC,oBAAQ,KAAK,QAAQ,IAAI,qBAAqB,QAAQ;AACzD,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,YAAY;AAAA,MAChB,MAAM;AACJ,2BAAI;AAAA,UACF,mBAAI,KAAK,WAAW;AAAA,UACpB;AAAA,QACF;AAGA,gBAAQ,KAAK,CAAC;AAAA,MAChB;AAAA,MACA,QAAQ,IAAI,mBACR,SAAS,QAAQ,IAAI,kBAAkB,EAAE,IACzC;AAAA,IACN;AAEA,WAAO,IAAI,EAAE,QAAQ,MAAM,aAAa,SAAS,CAAC;AAAA,EACpD;AAEA,qBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,iCAAiC;AAChE,YAAM,oCAAuB;AAC7B,4BAAS;AAET,UAAQ,WAAW;AACnB;AACF;AAEA,MAAM,EAAE,MAAM,2BAAc;",
+  "names": ["path"]
 }

package/lib/utils/dir.js

@@ -34,7 +34,6 @@ __export(dir_exports, {
 });
 module.exports = __toCommonJS(dir_exports);
 var import_path = __toESM(require("path"));
-var import_fdir = require("fdir");
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_ignore = __toESM(require("ignore"));
 var import_picomatch = __toESM(require("picomatch"));
@@ -50,17 +49,10 @@ const crawlDirectory = async (root, ignoreFilenames = [".gitignore"]) => {
   const ignoreFileFilter = await createInclusionFilter(
     ignoreFilenames.map((ignoreFilename) => import_path.default.join(root, ignoreFilename))
   );
-  const output = await new import_fdir.fdir().crawlWithOptions(root, {
-    exclude: (dirname) => [".git", "node_modules"].includes(dirname),
-    filters: [
-      (pathname) => {
-        const relativePathname = import_path.default.relative(root, pathname);
-        return ignoreFileFilter(relativePathname);
-      }
-    ],
-    includeBasePath: true
-  }).withPromise();
-  const absoluteFilenames = output;
+  const absoluteFilenames = await crawl(root, {
+    includeDirName: (dirname) => ![".git", "node_modules"].includes(dirname),
+    includeFilePath: (pathname) => ignoreFileFilter(import_path.default.relative(root, pathname))
+  });
   const relativeFilepaths = absoluteFilenames.map(
     (filepath) => import_path.default.relative(root, filepath)
   );
@@ -82,6 +74,26 @@ const createInclusionFilter = async (ignoreFilepaths) => {
   const managers = ignoreFiles.filter((value) => typeof value === "string").map((value) => (0, import_ignore.default)().add(value));
   return (0, import_ignore.default)().add(".git").add(managers).createFilter();
 };
+async function crawl(directoryPath, filters, paths = []) {
+  try {
+    const entries = await import_fs_extra.default.promises.readdir(directoryPath, {
+      withFileTypes: true
+    });
+    await Promise.all(
+      entries.map(async (entry) => {
+        const fullPath = import_path.default.join(directoryPath, entry.name);
+        if ((entry.isFile() || entry.isSymbolicLink()) && filters.includeFilePath(fullPath)) {
+          paths.push(fullPath);
+        }
+        if (entry.isDirectory() && filters.includeDirName(entry.name)) {
+          await crawl(fullPath, filters, paths);
+        }
+      })
+    );
+  } catch {
+  }
+  return paths;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   buildPatternToFilepathMap,

package/lib/utils/dir.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/dir.ts"],
-  "sourcesContent": ["import path from 'path';\n\nimport { fdir as FDir } from 'fdir';\nimport fs from 'fs-extra';\nimport ignore from 'ignore';\nimport picomatch from 'picomatch';\n\nimport { isErrorWithCode } from './error';\n\n/**\n * Build a map that associates each glob pattern with its matching filepaths.\n */\nexport const buildPatternToFilepathMap = (\n  patterns: string[],\n  allFilepaths: string[],\n  options?: picomatch.PicomatchOptions,\n) =>\n  Object.fromEntries(\n    patterns.map((pattern) => {\n      const isMatch = picomatch(pattern, options);\n\n      const filepaths = allFilepaths.filter((filepath) => isMatch(filepath));\n\n      return [pattern, filepaths] as const;\n    }),\n  );\n\n/**\n * List relative filepaths contained within a directory root.\n *\n * This excludes:\n *\n * - Patterns in the ignore files specified in `ignoreFilenames`\n * - `.git` subdirectories\n * - `node_modules` subdirectories\n */\nexport const crawlDirectory = async (\n  root: string,\n  ignoreFilenames = ['.gitignore'],\n) => {\n  const ignoreFileFilter = await createInclusionFilter(\n    ignoreFilenames.map((ignoreFilename) => path.join(root, ignoreFilename)),\n  );\n\n  const output = await new FDir()\n    .crawlWithOptions(root, {\n      exclude: (dirname) => ['.git', 'node_modules'].includes(dirname),\n      filters: [\n        (pathname) => {\n          const relativePathname = path.relative(root, pathname);\n\n          return ignoreFileFilter(relativePathname);\n        },\n      ],\n      includeBasePath: true,\n    })\n    .withPromise();\n\n  // Patch over non-specific `fdir` typings.\n  const absoluteFilenames = output as string[];\n\n  const relativeFilepaths = absoluteFilenames.map((filepath) =>\n    path.relative(root, filepath),\n  );\n\n  return relativeFilepaths;\n};\n\n/**\n * Create a filter function that excludes filepaths based on ignore files like\n * `.gitignore` and `.prettierignore`.\n */\nexport const createInclusionFilter = async (ignoreFilepaths: string[]) => {\n  const ignoreFiles = await Promise.all(\n    ignoreFilepaths.map(async (ignoreFilepath) => {\n      try {\n        return await fs.promises.readFile(ignoreFilepath, 'utf8');\n      } catch (err) {\n        if (isErrorWithCode(err, 'ENOENT')) {\n          return;\n        }\n\n        throw err;\n      }\n    }),\n  );\n\n  const managers = ignoreFiles\n    .filter((value): value is string => typeof value === 'string')\n    .map((value) => ignore().add(value));\n\n  return ignore().add('.git').add(managers).createFilter();\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,kBAA6B;AAC7B,sBAAe;AACf,oBAAmB;AACnB,uBAAsB;AAEtB,mBAAgC;AAKzB,MAAM,4BAA4B,CACvC,UACA,cACA,YAEA,OAAO;AAAA,EACL,SAAS,IAAI,CAAC,YAAY;AACxB,UAAM,cAAU,iBAAAA,SAAU,SAAS,OAAO;AAE1C,UAAM,YAAY,aAAa,OAAO,CAAC,aAAa,QAAQ,QAAQ,CAAC;AAErE,WAAO,CAAC,SAAS,SAAS;AAAA,EAC5B,CAAC;AACH;AAWK,MAAM,iBAAiB,OAC5B,MACA,kBAAkB,CAAC,YAAY,MAC5B;AACH,QAAM,mBAAmB,MAAM;AAAA,IAC7B,gBAAgB,IAAI,CAAC,mBAAmB,YAAAC,QAAK,KAAK,MAAM,cAAc,CAAC;AAAA,EACzE;AAEA,QAAM,SAAS,MAAM,IAAI,YAAAC,KAAK,EAC3B,iBAAiB,MAAM;AAAA,IACtB,SAAS,CAAC,YAAY,CAAC,QAAQ,cAAc,EAAE,SAAS,OAAO;AAAA,IAC/D,SAAS;AAAA,MACP,CAAC,aAAa;AACZ,cAAM,mBAAmB,YAAAD,QAAK,SAAS,MAAM,QAAQ;AAErD,eAAO,iBAAiB,gBAAgB;AAAA,MAC1C;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EACnB,CAAC,EACA,YAAY;AAGf,QAAM,oBAAoB;AAE1B,QAAM,oBAAoB,kBAAkB;AAAA,IAAI,CAAC,aAC/C,YAAAA,QAAK,SAAS,MAAM,QAAQ;AAAA,EAC9B;AAEA,SAAO;AACT;AAMO,MAAM,wBAAwB,OAAO,oBAA8B;AACxE,QAAM,cAAc,MAAM,QAAQ;AAAA,IAChC,gBAAgB,IAAI,OAAO,mBAAmB;AAC5C,UAAI;AACF,eAAO,MAAM,gBAAAE,QAAG,SAAS,SAAS,gBAAgB,MAAM;AAAA,MAC1D,SAAS,KAAK;AACZ,gBAAI,8BAAgB,KAAK,QAAQ,GAAG;AAClC;AAAA,QACF;AAEA,cAAM;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,YACd,OAAO,CAAC,UAA2B,OAAO,UAAU,QAAQ,EAC5D,IAAI,CAAC,cAAU,cAAAC,SAAO,EAAE,IAAI,KAAK,CAAC;AAErC,aAAO,cAAAA,SAAO,EAAE,IAAI,MAAM,EAAE,IAAI,QAAQ,EAAE,aAAa;AACzD;",
-  "names": ["picomatch", "path", "FDir", "fs", "ignore"]
+  "sourcesContent": ["import path from 'path';\n\nimport fs from 'fs-extra';\nimport ignore from 'ignore';\nimport picomatch from 'picomatch';\n\nimport { isErrorWithCode } from './error';\n\n/**\n * Build a map that associates each glob pattern with its matching filepaths.\n */\nexport const buildPatternToFilepathMap = (\n  patterns: string[],\n  allFilepaths: string[],\n  options?: picomatch.PicomatchOptions,\n) =>\n  Object.fromEntries(\n    patterns.map((pattern) => {\n      const isMatch = picomatch(pattern, options);\n\n      const filepaths = allFilepaths.filter((filepath) => isMatch(filepath));\n\n      return [pattern, filepaths] as const;\n    }),\n  );\n\n/**\n * List relative filepaths contained within a directory root.\n *\n * This excludes:\n *\n * - Patterns in the ignore files specified in `ignoreFilenames`\n * - `.git` subdirectories\n * - `node_modules` subdirectories\n */\nexport const crawlDirectory = async (\n  root: string,\n  ignoreFilenames = ['.gitignore'],\n) => {\n  const ignoreFileFilter = await createInclusionFilter(\n    ignoreFilenames.map((ignoreFilename) => path.join(root, ignoreFilename)),\n  );\n\n  const absoluteFilenames = await crawl(root, {\n    includeDirName: (dirname) => !['.git', 'node_modules'].includes(dirname),\n    includeFilePath: (pathname) =>\n      ignoreFileFilter(path.relative(root, pathname)),\n  });\n\n  const relativeFilepaths = absoluteFilenames.map((filepath) =>\n    path.relative(root, filepath),\n  );\n\n  return relativeFilepaths;\n};\n\n/**\n * Create a filter function that excludes filepaths based on ignore files like\n * `.gitignore` and `.prettierignore`.\n */\nexport const createInclusionFilter = async (ignoreFilepaths: string[]) => {\n  const ignoreFiles = await Promise.all(\n    ignoreFilepaths.map(async (ignoreFilepath) => {\n      try {\n        return await fs.promises.readFile(ignoreFilepath, 'utf8');\n      } catch (err) {\n        if (isErrorWithCode(err, 'ENOENT')) {\n          return;\n        }\n\n        throw err;\n      }\n    }),\n  );\n\n  const managers = ignoreFiles\n    .filter((value): value is string => typeof value === 'string')\n    .map((value) => ignore().add(value));\n\n  return ignore().add('.git').add(managers).createFilter();\n};\n\n/**\n * Recursively crawl a directory and return all file paths that match the\n * filters. `paths` is mutated and returned.\n */\nasync function crawl(\n  directoryPath: string,\n  filters: {\n    includeDirName: (dirName: string) => boolean;\n    includeFilePath: (path: string) => boolean;\n  },\n  paths: string[] = [],\n) {\n  try {\n    const entries = await fs.promises.readdir(directoryPath, {\n      withFileTypes: true,\n    });\n\n    await Promise.all(\n      entries.map(async (entry) => {\n        const fullPath = path.join(directoryPath, entry.name);\n\n        if (\n          (entry.isFile() || entry.isSymbolicLink()) &&\n          filters.includeFilePath(fullPath)\n        ) {\n          paths.push(fullPath);\n        }\n\n        if (entry.isDirectory() && filters.includeDirName(entry.name)) {\n          await crawl(fullPath, filters, paths);\n        }\n      }),\n    );\n  } catch {\n    // Ignore errors, because of e.g. permission issues reading directories\n  }\n\n  return paths;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAe;AACf,oBAAmB;AACnB,uBAAsB;AAEtB,mBAAgC;AAKzB,MAAM,4BAA4B,CACvC,UACA,cACA,YAEA,OAAO;AAAA,EACL,SAAS,IAAI,CAAC,YAAY;AACxB,UAAM,cAAU,iBAAAA,SAAU,SAAS,OAAO;AAE1C,UAAM,YAAY,aAAa,OAAO,CAAC,aAAa,QAAQ,QAAQ,CAAC;AAErE,WAAO,CAAC,SAAS,SAAS;AAAA,EAC5B,CAAC;AACH;AAWK,MAAM,iBAAiB,OAC5B,MACA,kBAAkB,CAAC,YAAY,MAC5B;AACH,QAAM,mBAAmB,MAAM;AAAA,IAC7B,gBAAgB,IAAI,CAAC,mBAAmB,YAAAC,QAAK,KAAK,MAAM,cAAc,CAAC;AAAA,EACzE;AAEA,QAAM,oBAAoB,MAAM,MAAM,MAAM;AAAA,IAC1C,gBAAgB,CAAC,YAAY,CAAC,CAAC,QAAQ,cAAc,EAAE,SAAS,OAAO;AAAA,IACvE,iBAAiB,CAAC,aAChB,iBAAiB,YAAAA,QAAK,SAAS,MAAM,QAAQ,CAAC;AAAA,EAClD,CAAC;AAED,QAAM,oBAAoB,kBAAkB;AAAA,IAAI,CAAC,aAC/C,YAAAA,QAAK,SAAS,MAAM,QAAQ;AAAA,EAC9B;AAEA,SAAO;AACT;AAMO,MAAM,wBAAwB,OAAO,oBAA8B;AACxE,QAAM,cAAc,MAAM,QAAQ;AAAA,IAChC,gBAAgB,IAAI,OAAO,mBAAmB;AAC5C,UAAI;AACF,eAAO,MAAM,gBAAAC,QAAG,SAAS,SAAS,gBAAgB,MAAM;AAAA,MAC1D,SAAS,KAAK;AACZ,gBAAI,8BAAgB,KAAK,QAAQ,GAAG;AAClC;AAAA,QACF;AAEA,cAAM;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,YACd,OAAO,CAAC,UAA2B,OAAO,UAAU,QAAQ,EAC5D,IAAI,CAAC,cAAU,cAAAC,SAAO,EAAE,IAAI,KAAK,CAAC;AAErC,aAAO,cAAAA,SAAO,EAAE,IAAI,MAAM,EAAE,IAAI,QAAQ,EAAE,aAAa;AACzD;AAMA,eAAe,MACb,eACA,SAIA,QAAkB,CAAC,GACnB;AACA,MAAI;AACF,UAAM,UAAU,MAAM,gBAAAD,QAAG,SAAS,QAAQ,eAAe;AAAA,MACvD,eAAe;AAAA,IACjB,CAAC;AAED,UAAM,QAAQ;AAAA,MACZ,QAAQ,IAAI,OAAO,UAAU;AAC3B,cAAM,WAAW,YAAAD,QAAK,KAAK,eAAe,MAAM,IAAI;AAEpD,aACG,MAAM,OAAO,KAAK,MAAM,eAAe,MACxC,QAAQ,gBAAgB,QAAQ,GAChC;AACA,gBAAM,KAAK,QAAQ;AAAA,QACrB;AAEA,YAAI,MAAM,YAAY,KAAK,QAAQ,eAAe,MAAM,IAAI,GAAG;AAC7D,gBAAM,MAAM,UAAU,SAAS,KAAK;AAAA,QACtC;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,QAAQ;AAAA,EAER;AAEA,SAAO;AACT;",
+  "names": ["picomatch", "path", "fs", "ignore"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "7.5.0",
+  "version": "7.5.2-jest-node-next-20240319045958",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -52,8 +52,8 @@
   "dependencies": {
     "@esbuild-plugins/tsconfig-paths": "^0.1.0",
     "@jest/types": "^29.0.0",
-    "@octokit/graphql": "^7.0.0",
-    "@octokit/graphql-schema": "^14.5.0",
+    "@octokit/graphql": "^8.0.0",
+    "@octokit/graphql-schema": "^15.3.0",
     "@octokit/rest": "^20.0.0",
     "@octokit/types": "^12.0.0",
     "@types/jest": "^29.0.0",
@@ -69,7 +69,6 @@
     "eslint-config-skuba": "3.1.0",
     "execa": "^5.0.0",
     "fast-glob": "^3.3.2",
-    "fdir": "^6.0.0",
     "fs-extra": "^11.0.0",
     "function-arguments": "^1.0.9",
     "get-port": "^5.1.1",
@@ -101,7 +100,6 @@
     "tsconfig-seek": "2.0.0",
     "typescript": "~5.3.0",
     "validate-npm-package-name": "^5.0.0",
-    "why-is-node-running": "^2.2.2",
     "zod": "^3.22.4"
   },
   "devDependencies": {
@@ -141,7 +139,7 @@
       "optional": true
     }
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=18.12"
   },

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

@@ -56,7 +56,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.0.0:
+      - docker-compose#v5.2.0:
           run: app
           environment:
             - GITHUB_API_TOKEN
@@ -69,7 +69,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: build
           file: gantry.build.yml
           region: <%- region %>
@@ -86,7 +86,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     key: deploy-dev
     plugins:
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: apply
           environment: <%- devGantryEnvironmentName %>
           file: gantry.apply.yml
@@ -101,7 +101,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     depends_on: deploy-dev
     plugins:
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: apply
           environment: <%- prodGantryEnvironmentName %>
           file: gantry.apply.yml

package/template/express-rest-api/.gantry/common.yml

@@ -1,20 +1,15 @@
+owner: '<%- teamName %>'
 prodAccountId: '<%- prodAwsAccountId %>'
+service: '<%- serviceName %>'
 
 image: '{{values "prodAccountId"}}.dkr.ecr.<%- region %>.amazonaws.com/{{values "service"}}:{{.BuildID}}'
-service: '<%- serviceName %>'
 
 # TODO: enable Datadog agent
 # https://backstage.myseek.xyz/docs/default/component/gantry/v1/reference/resources/service/#datadogSecretId
 # datadogSecretId: arn:aws:secretsmanager:<%- region %>:<aws-account-id>:secret:<secret-name>
 
 tags:
-  # TODO: add data classification tags
-  # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdataconsumers
-  # seek:data:consumers: internal
-  # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdatatypes
-  # seek:data:types:restricted: job-ads
-  seek:env:label: '{{values "environment"}}'
-  seek:env:production: '{{values "isProduction"}}'
-  seek:owner:team: '<%- teamName %>'
+  seek:env:prod: '{{values "isProduction"}}'
   seek:source:sha: '{{.CommitSHA}}'
   seek:source:url: 'https://github.com/SEEK-Jobs/<%- repoName %>'
+  # seek:system:name: 'TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#required-tags'

package/template/express-rest-api/Dockerfile

@@ -12,7 +12,7 @@ RUN pnpm install --offline --prod
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian12 AS runtime
+FROM --platform=<%- platformName %> gcr.io/distroless/nodejs20-debian12 AS runtime
 
 WORKDIR /workdir
 

package/template/express-rest-api/Dockerfile.dev-deps

@@ -1,6 +1,6 @@
-# syntax=docker/dockerfile:1.6
+# syntax=docker/dockerfile:1.7
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
+FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 
 RUN corepack enable pnpm
 RUN pnpm config set store-dir /root/.pnpm-store

package/template/express-rest-api/gantry.apply.yml

@@ -4,6 +4,8 @@ schemaVersion: v0.0
 
 name: '{{values "service"}}'
 
+owner: '{{values "owner"}}'
+
 image: '{{values "image"}}'
 
 env:

package/template/express-rest-api/package.json

@@ -24,7 +24,7 @@
     "skuba": "*",
     "supertest": "^6.1.6"
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=20"
   }

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

@@ -35,7 +35,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.0.0:
+      - docker-compose#v5.2.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

package/template/greeter/Dockerfile

@@ -1,6 +1,6 @@
-# syntax=docker/dockerfile:1.6
+# syntax=docker/dockerfile:1.7
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
+FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 
 RUN corepack enable pnpm
 RUN pnpm config set store-dir /root/.pnpm-store

package/template/greeter/package.json

@@ -18,7 +18,7 @@
     "@types/node": "^20.9.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=20"
   }

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

@@ -56,7 +56,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.0.0:
+      - docker-compose#v5.2.0:
           run: app
           environment:
             - GITHUB_API_TOKEN
@@ -69,7 +69,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: build
           file: gantry.build.yml
           region: <%- region %>
@@ -86,7 +86,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- devGantryEnvironmentName %>
     key: deploy-dev
     plugins:
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: apply
           environment: <%- devGantryEnvironmentName %>
           file: gantry.apply.yml
@@ -101,7 +101,7 @@ steps:
     concurrency_group: <%- teamName %>/deploy/gantry/<%- prodGantryEnvironmentName %>
     depends_on: deploy-dev
     plugins:
-      - seek-jobs/gantry#v2.0.0:
+      - seek-jobs/gantry#v3.0.0:
           command: apply
           environment: <%- prodGantryEnvironmentName %>
           file: gantry.apply.yml

package/template/koa-rest-api/.gantry/common.yml

@@ -1,20 +1,15 @@
+owner: '<%- teamName %>'
 prodAccountId: '<%- prodAwsAccountId %>'
+service: '<%- serviceName %>'
 
 image: '{{values "prodAccountId"}}.dkr.ecr.<%- region %>.amazonaws.com/{{values "service"}}:{{.BuildID}}'
-service: '<%- serviceName %>'
 
 # TODO: enable Datadog agent
 # https://backstage.myseek.xyz/docs/default/component/gantry/v1/reference/resources/service/#datadogSecretId
 # datadogSecretId: arn:aws:secretsmanager:<%- region %>:<aws-account-id>:secret:<secret-name>
 
 tags:
-  # TODO: add data classification tags
-  # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdataconsumers
-  # seek:data:consumers: internal
-  # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdatatypes
-  # seek:data:types:restricted: job-ads
-  seek:env:label: '{{values "environment"}}'
-  seek:env:production: '{{values "isProduction"}}'
-  seek:owner:team: '<%- teamName %>'
+  seek:env:prod: '{{values "isProduction"}}'
   seek:source:sha: '{{.CommitSHA}}'
   seek:source:url: 'https://github.com/SEEK-Jobs/<%- repoName %>'
+  # seek:system:name: 'TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#required-tags'

package/template/koa-rest-api/Dockerfile

@@ -12,7 +12,7 @@ RUN pnpm install --offline --prod
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian12 AS runtime
+FROM --platform=<%- platformName %> gcr.io/distroless/nodejs20-debian12 AS runtime
 
 WORKDIR /workdir
 

package/template/koa-rest-api/Dockerfile.dev-deps

@@ -1,6 +1,6 @@
-# syntax=docker/dockerfile:1.6
+# syntax=docker/dockerfile:1.7
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
+FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 
 RUN corepack enable pnpm
 RUN pnpm config set store-dir /root/.pnpm-store

package/template/koa-rest-api/gantry.apply.yml

@@ -4,6 +4,8 @@ schemaVersion: v0.0
 
 name: '{{values "service"}}'
 
+owner: '{{values "owner"}}'
+
 image: '{{values "image"}}'
 
 env:

package/template/koa-rest-api/package.json

@@ -15,11 +15,11 @@
     "@koa/router": "^12.0.0",
     "@opentelemetry/api": "^1.1.0",
     "@opentelemetry/core": "^1.18.1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.48.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.38.0",
-    "@opentelemetry/instrumentation-http": "^0.48.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.49.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.39.0",
+    "@opentelemetry/instrumentation-http": "^0.49.0",
     "@opentelemetry/propagator-b3": "^1.18.1",
-    "@opentelemetry/sdk-node": "^0.48.0",
+    "@opentelemetry/sdk-node": "^0.49.0",
     "@seek/logger": "^6.0.0",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^10.0.0",
@@ -43,7 +43,7 @@
     "skuba": "*",
     "supertest": "^6.1.6"
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=20"
   }

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

@@ -35,7 +35,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v5.0.0:
+        - docker-compose#v5.2.0:
             dependencies: false
             run: app
             propagate-environment: true
@@ -66,7 +66,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.0.0:
+      - docker-compose#v5.2.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

package/template/lambda-sqs-worker/Dockerfile

@@ -1,6 +1,6 @@
-# syntax=docker/dockerfile:1.6
+# syntax=docker/dockerfile:1.7
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
+FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 
 RUN corepack enable pnpm
 RUN pnpm config set store-dir /root/.pnpm-store

package/template/lambda-sqs-worker/package.json

@@ -37,7 +37,7 @@
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=20"
   }

package/template/lambda-sqs-worker/serverless.yml

@@ -5,6 +5,18 @@ configValidationMode: error
 params:
   default:
     datadogApiKeySecretArn: 'TODO: arn:aws:secretsmanager:${aws:region}:${aws:accountId}:secret:SECRET-NAME'
+    dataStoreTags:
+      - Key: seek:auto:backup:frequency
+        Value: none
+      # TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#data-services
+      # - Key: seek:data:derived
+      #   Value: copy
+      # - Key: seek:data:domain
+      #   Value: unassigned
+      # - Key: seek:data:jurisdiction-source
+      #   Value: australia hong-kong indonesia malaysia new-zealand philippines singapore thailand
+      # - Key: seek:data:types:restricted
+      #   Value: job-ads
     description: <%- description %>
   dev:
     deploymentBucket: 'TODO: deployment-bucket-name'
@@ -70,16 +82,15 @@ provider:
           Effect: Allow
           Resource: !Ref DestinationTopic
   stackTags:
-    # TODO: add data classification tags
-    # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdataconsumers
-    # seek:data:consumers: internal
-    # https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#seekdatatypes
-    # seek:data:types:restricted: job-ads
     seek:env:label: ${env:ENVIRONMENT}
-    seek:env:production: ${param:isProduction}
-    seek:owner:team: '<%- teamName %>'
+    seek:env:prod: ${param:isProduction}
+    # seek:owner:cost-centre: 'TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#required-tags'
+    seek:owner:technical: '<%- teamName %>'
     seek:source:sha: ${env:BUILDKITE_COMMIT, 'na'}
     seek:source:url: 'https://github.com/SEEK-Jobs/<%- repoName %>'
+    seek:system:deployed-by: CFN
+    # seek:system:name: 'TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#required-tags'
+    # seek:system:org: 'TODO: https://rfc.skinfra.xyz/RFC019-AWS-Tagging-Standard.html#required-tags'
 
 package:
   patterns:
@@ -131,6 +142,7 @@ resources:
         KmsDataKeyReusePeriodSeconds: 300
         KmsMasterKeyId: !Ref EncryptionKey
         QueueName: ${self:service}-dead-letters
+        Tags: ${param:dataStoreTags}
 
     MessageQueue:
       Type: AWS::SQS::Queue
@@ -142,6 +154,7 @@ resources:
         RedrivePolicy:
           deadLetterTargetArn: !GetAtt DeadLetterQueue.Arn
           maxReceiveCount: 3
+        Tags: ${param:dataStoreTags}
         VisibilityTimeout: 180
 
     # MessageQueuePolicy:
@@ -173,6 +186,7 @@ resources:
       Type: AWS::SNS::Topic
       Properties:
         KmsMasterKeyId: alias/aws/sns
+        Tags: ${param:dataStoreTags}
         TopicName: ${self:service}
 
     EncryptionKey:

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

@@ -32,7 +32,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v5.0.0:
+        - docker-compose#v5.2.0:
             dependencies: false
             run: app
             environment:
@@ -62,7 +62,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v5.0.0:
+      - docker-compose#v5.2.0:
           run: app
           environment:
             - GITHUB_API_TOKEN

package/template/lambda-sqs-worker-cdk/Dockerfile

@@ -1,6 +1,6 @@
-# syntax=docker/dockerfile:1.6
+# syntax=docker/dockerfile:1.7
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
+FROM --platform=<%- platformName %> node:20-alpine AS dev-deps
 
 # Needed for cdk
 RUN apk add --no-cache bash

package/template/lambda-sqs-worker-cdk/cdk.json

@@ -8,7 +8,7 @@
       "workerLambda": {
         "reservedConcurrency": 2,
         "environment": {
-          "SOMETHING": "dev"
+          "ENVIRONMENT": "dev"
         }
       },
       "sourceSnsTopicArn": "TODO: sourceSnsTopicArn"
@@ -17,7 +17,7 @@
       "workerLambda": {
         "reservedConcurrency": 20,
         "environment": {
-          "SOMETHING": "prod"
+          "ENVIRONMENT": "prod"
         }
       },
       "sourceSnsTopicArn": "TODO: sourceSnsTopicArn"

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

@@ -448,9 +448,9 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
         "Description": "Updated at 1212-12-12T12:12:12.121Z",
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "dev",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "dev",
           },
         },
         "FunctionName": "serviceName",
@@ -638,12 +638,12 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
         },
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "dev",
             "FUNCTION_NAME_TO_PRUNE": {
               "Ref": "worker28EA3E30",
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "dev",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -790,12 +790,12 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
         },
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "dev",
             "FUNCTION_NAME_TO_INVOKE": {
               "Ref": "worker28EA3E30",
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "dev",
           },
         },
         "FunctionName": "serviceName-pre-hook",
@@ -1490,9 +1490,9 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
         "Description": "Updated at 1212-12-12T12:12:12.121Z",
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "prod",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "prod",
           },
         },
         "FunctionName": "serviceName",
@@ -1680,12 +1680,12 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
         },
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "prod",
             "FUNCTION_NAME_TO_PRUNE": {
               "Ref": "worker28EA3E30",
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "prod",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -1832,12 +1832,12 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
         },
         "Environment": {
           "Variables": {
+            "ENVIRONMENT": "prod",
             "FUNCTION_NAME_TO_INVOKE": {
               "Ref": "worker28EA3E30",
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
-            "SOMETHING": "prod",
           },
         },
         "FunctionName": "serviceName-pre-hook",

package/template/lambda-sqs-worker-cdk/package.json

@@ -26,7 +26,7 @@
     "constructs": "^10.0.17",
     "skuba": "*"
   },
-  "packageManager": "pnpm@8.15.3",
+  "packageManager": "pnpm@8.15.4",
   "engines": {
     "node": ">=20"
   }

package/template/lambda-sqs-worker-cdk/shared/context-types.ts

@@ -7,7 +7,7 @@ export const EnvContextSchema = z.object({
   workerLambda: z.object({
     reservedConcurrency: z.number(),
     environment: z.object({
-      SOMETHING: z.string(),
+      ENVIRONMENT: z.string(),
     }),
   }),
   sourceSnsTopicArn: z.string(),