skuba 0.0.0-master-20231002013336 → 0.0.0-master-20231121000709

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

@@ -14,11 +14,12 @@ configs:
           - package.json
           - yarn.lock
         dockerfile: Dockerfile.dev-deps
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -53,7 +54,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1 +1 @@
-18
+20

package/template/express-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs18-debian11 AS runtime
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian11 AS runtime
 
 WORKDIR /workdir
 

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

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

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

@@ -19,12 +19,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
+<%-repoName %> is a Node.js HTTP server built in line with our [Technical Guidelines].
 It uses the [Express] middleware framework and common SEEK packages.
 Resource APIs enable synchronous interactions and serve as the backbone of SEEK's general service architecture.
 
@@ -100,7 +100,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[express]: https://expressjs.com
-[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Express]: https://expressjs.com
+[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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

@@ -18,13 +18,13 @@
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "@types/supertest": "^2.0.11",
     "pino-pretty": "^10.0.0",
     "skuba": "*",
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
 steps:
   - label: 🧪 Test & Lint
@@ -32,6 +33,6 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10

package/template/greeter/.nvmrc

@@ -1 +1 @@
-18
+20

package/template/greeter/Dockerfile

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

package/template/greeter/README.md

@@ -17,13 +17,13 @@ Next steps:
 5. [ ] Configure [GitHub repository settings].
 6. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
 The `greeter` template is the prototypical _hello world_ project.
-It can function as a playground for the TypeScript tooling prescribed by our [technology strategy],
+It can function as a playground for the TypeScript tooling prescribed by our [Technical Guidelines],
 or serve as a starting point for a backend project if the other built-in templates are not a good fit.
 
 It's a barebones Node.js application that comprises:
@@ -93,4 +93,4 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

package/template/greeter/package.json

@@ -15,10 +15,10 @@
     "skuba-dive": "^2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

@@ -14,11 +14,12 @@ configs:
           - package.json
           - yarn.lock
         dockerfile: Dockerfile.dev-deps
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -53,7 +54,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

package/template/koa-rest-api/Dockerfile

@@ -17,7 +17,7 @@ RUN yarn build
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs18-debian11 AS runtime
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian11 AS runtime
 
 WORKDIR /workdir
 

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

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

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

@@ -19,12 +19,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
+<%-repoName %> is a Node.js HTTP server built in line with our [Technical Guidelines].
 It uses the [Koa] middleware framework and common SEEK packages.
 Resource APIs enable synchronous interactions and serve as the backbone of SEEK's general service architecture.
 
@@ -105,7 +105,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
-[koa]: https://koajs.com
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[Koa]: https://koajs.com
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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

@@ -14,10 +14,10 @@
   "dependencies": {
     "@koa/router": "^12.0.0",
     "@opentelemetry/api": "^1.1.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.43.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.45.0",
     "@opentelemetry/instrumentation-aws-sdk": "^0.36.0",
-    "@opentelemetry/instrumentation-http": "^0.43.0",
-    "@opentelemetry/sdk-node": "^0.43.0",
+    "@opentelemetry/instrumentation-http": "^0.45.0",
+    "@opentelemetry/sdk-node": "^0.45.0",
     "@seek/logger": "^6.0.0",
     "aws-sdk": "^2.1039.0",
     "hot-shots": "^10.0.0",
@@ -34,7 +34,7 @@
     "@types/koa": "^2.13.4",
     "@types/koa-bodyparser": "^5.0.2",
     "@types/koa__router": "^12.0.0",
-    "@types/node": "^18.11.5",
+    "@types/node": "^20.9.0",
     "@types/supertest": "^2.0.11",
     "chance": "^1.1.8",
     "pino-pretty": "^10.0.0",
@@ -42,6 +42,6 @@
     "supertest": "^6.1.6"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

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

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -32,7 +33,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.14.0:
+        - docker-compose#v4.16.0:
             dependencies: false
             run: app
       retry:
@@ -60,7 +61,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1 +1 @@
-18
+20

package/template/lambda-sqs-worker/Dockerfile

@@ -1,12 +1,12 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive && \
   yarn cache clean

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

@@ -18,12 +18,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js [Lambda] application built in line with our [technology strategy].
+<%-repoName %> is a Node.js [Lambda] application built in line with our [Technical Guidelines].
 It is backed by a typical SQS message + dead letter queue configuration and uses common SEEK packages.
 Workers enable fault-tolerant asynchronous processing of events.
 
@@ -126,7 +126,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[lambda]: https://docs.aws.amazon.com/lambda
-[serverless]: https://www.serverless.com/
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Lambda]: https://docs.aws.amazon.com/lambda
+[Serverless]: https://www.serverless.com/
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

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

@@ -27,18 +27,18 @@
   "devDependencies": {
     "@types/aws-lambda": "^8.10.84",
     "@types/chance": "^1.1.3",
-    "@types/node": "^18.11.9",
+    "@types/node": "^20.9.0",
     "aws-sdk-client-mock": "^3.0.0",
     "aws-sdk-client-mock-jest": "^3.0.0",
     "chance": "^1.1.8",
     "pino-pretty": "^10.0.0",
-    "serverless": "^3.25.0",
+    "serverless": "^3.37.0",
     "serverless-plugin-canary-deployments": "^0.8.0",
     "serverless-plugin-datadog": "^5.12.0",
     "serverless-prune-plugin": "^2.0.0",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

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

@@ -37,7 +37,7 @@ provider:
   logRetentionInDays: 30
   name: aws
   region: ap-southeast-2
-  runtime: nodejs18.x
+  runtime: nodejs20.x
   architecture: <%- lambdaServerlessArchitecture %>
   deploymentMethod: direct
   stackName: ${self:service}

package/template/lambda-sqs-worker/src/framework/validation.test.ts

@@ -78,7 +78,7 @@ describe('validateJson', () => {
     expect(() =>
       validateJson(input, IdDescriptionSchema),
     ).toThrowErrorMatchingInlineSnapshot(
-      `"Unexpected token } in JSON at position 0"`,
+      `"Unexpected token '}', "}" is not valid JSON"`,
     );
   });
 });

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

@@ -13,11 +13,12 @@ configs:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -32,7 +33,7 @@ configs:
         - *aws-sm
         - *private-npm
         - *docker-ecr-cache
-        - docker-compose#v4.14.0:
+        - docker-compose#v4.16.0:
             dependencies: false
             run: app
       retry:
@@ -57,7 +58,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

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

@@ -1,13 +1,13 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
 WORKDIR /workdir
 
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive && \
   yarn package && \
   yarn cache clean

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

@@ -176,7 +176,7 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs18.x",
+        "Runtime": "nodejs20.x",
       },
       "Type": "AWS::Lambda::Function",
     },
@@ -537,7 +537,7 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             "Arn",
           ],
         },
-        "Runtime": "nodejs18.x",
+        "Runtime": "nodejs20.x",
       },
       "Type": "AWS::Lambda::Function",
     },

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

@@ -55,7 +55,7 @@ export class AppStack extends Stack {
     const worker = new aws_lambda.Function(this, 'worker', {
       architecture: aws_lambda.Architecture[architecture],
       code: new aws_lambda.AssetCode('./lib'),
-      runtime: aws_lambda.Runtime.NODEJS_18_X,
+      runtime: aws_lambda.Runtime.NODEJS_20_X,
       handler: 'app.handler',
       functionName: '<%- serviceName %>',
       environmentEncryption: kmsKey,

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

@@ -18,13 +18,13 @@
   "devDependencies": {
     "@aws-cdk/assert": "^2.24.0",
     "@types/aws-lambda": "^8.10.82",
-    "@types/node": "^18.11.9",
-    "aws-cdk": "^2.51.1",
-    "aws-cdk-lib": "^2.51.1",
+    "@types/node": "^20.9.0",
+    "aws-cdk": "^2.109.0",
+    "aws-cdk-lib": "^2.109.0",
     "constructs": "^10.0.17",
     "skuba": "*"
   },
   "engines": {
-    "node": ">=18.12"
+    "node": ">=20"
   }
 }

package/template/oss-npm-package/.nvmrc

@@ -1 +1 @@
-18
+20

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

@@ -121,7 +121,7 @@ Here are some branches that **semantic-release** supports by default:
 For more information, see the **semantic-release** docs on [triggering a release].
 
 [distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
-[oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
+[OSS npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
 [release workflow]: .github/workflows/release.yml
 [seek-oss]: https://github.com/seek-oss
 [semantic-release]: https://github.com/semantic-release/semantic-release

package/template/private-npm-package/.nvmrc

@@ -1 +1 @@
-18
+20

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

@@ -103,7 +103,7 @@ Here are some branches that **semantic-release** supports by default:
 For more information, see the **semantic-release** docs on [triggering a release].
 
 [distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
-[gutenberg]: https://github.com/SEEK-Jobs/gutenberg
-[seek-jobs]: https://github.com/orgs/seek-jobs/sso
+[Gutenberg]: https://github.com/SEEK-Jobs/gutenberg
+[SEEK-Jobs]: https://github.com/orgs/seek-jobs/sso
 [semantic-release]: https://github.com/semantic-release/semantic-release
 [triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release