Merge remote-tracking branch 'origin/main' into renovate-eslint-9.x

.changeset/empty-cherries-admire.md

@@ -0,0 +1,14 @@
+---
+'skuba': major
+---
+
+node, start: Replace `ts-node` with `tsx`
+
+`skuba start` and `skuba node` now use `tsx` instead of `ts-node` for running TypeScript files. `tsx` has better ESM interoperability, like support for dynamic imports (`await import()`), than `ts-node`.
+
+There are some downsides for the REPL (which is what `skuba node` without any file is):
+
+- `import` statements in the REPL are not supported; `require` and `await import()` are still supported.
+- Pasting code into the REPL may not work as well as `ts-node`. If encountering issues, a workaround could be to use [`.editor`](https://nodejs.org/en/learn/command-line/how-to-use-the-nodejs-repl#dot-commands)
+
+Otherwise, `skuba start` and `skuba node <file>` _should_ work as expected. However, it is difficult to comprehensively test every scenario, so this has been released as a major version. It is recommended to test your use-cases of `skuba start` and `skuba node` after upgrading.

.changeset/heavy-scissors-divide.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+template/koa-rest-api: Enable secure headers middleware by default

.changeset/hot-crews-swim.md

@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+lint: Removes obsolete version field from docker-compose.yml files

.changeset/hungry-keys-cover.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+template: Add required tags to `lambda-sqs-worker-cdk` template

.changeset/quick-icons-taste.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+api: Truncate Buildkite annotations over 1 MiB to resolve `buildkite-agent` crash

.changeset/shiny-parents-sit.md

@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+template/lambda-sqs-worker-cdk: Replace custom hooks with `@seek/aws-codedeploy-infra`

.github/renovate.json5

@@ -92,6 +92,16 @@
       prPriority: 99,
       schedule: 'before 3:00 am every weekday',
     },
+    {
+      matchDepTypes: ['devDependencies'],
+      matchManagers: ['npm'],
+      semanticCommitType: 'devDeps',
+    },
+    {
+      matchDepTypes: ['dependencies', 'peerDependencies'],
+      matchManagers: ['npm'],
+      semanticCommitType: 'deps',
+    },
     {
       matchPaths: ['template/**'],
 
@@ -102,13 +112,14 @@
   ],
   branchPrefix: 'renovate-',
   commitMessageAction: '',
+  gitIgnoredAuthors: ['[email protected]'],
   postUpdateOptions: [],
   prConcurrentLimit: 3,
   prNotPendingHours: 1,
   rangeStrategy: 'replace',
   schedule: 'after 3:00 am and before 6:00 am every weekday',
   semanticCommitScope: '',
-  semanticCommitType: 'deps',
+  semanticCommitType: 'update',
   customManagers: [
     {
       customType: 'regex',

.github/workflows/renovate-changeset.yml

@@ -0,0 +1,87 @@
+# Modelled on https://github.com/backstage/backstage/blob/5083c8024deffbdf454983900f02780d14b55a0b/.github/workflows/sync_renovate-changesets.yml#L6
+
+name: Sync Renovate changeset
+on:
+  pull_request_target:
+    paths:
+      - '.github/workflows/renovate-changeset.yml'
+      - 'pnpm-lock.yaml'
+
+jobs:
+  generate-changeset:
+    runs-on: ubuntu-latest
+    if: github.actor == 'renovate[bot]' && github.repository == 'seek-oss/skuba'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.SEEK_OSS_CI_GITHUB_TOKEN }}
+      - name: Configure Git
+        run: |
+          git config --global user.email [email protected]
+          git config --global user.name 'Github changeset workflow'
+      - name: Generate changeset
+        uses: actions/github-script@v7
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        with:
+          script: |
+            const { promises: fs } = require('fs');
+
+            async function getPackagesNames(files) {
+              const packageJsons = await Promise.all(
+                files.map(async (file) => JSON.parse(await fs.readFile(file, 'utf8'))),
+              );
+
+              return packageJsons.flatMap((d) => (d.private ? [] : [d.name]));
+            }
+
+            async function createChangeset(fileName, message, packages) {
+              const header = packages.map((pkg) => `'${pkg}': patch`).join('\n');
+              const body = `---\n${header}\n---\n\n${message.trim()}\n`;
+              await fs.writeFile(fileName, body);
+            }
+
+            const prTitle = process.env.PR_TITLE;
+            if (!prTitle) {
+              console.log('No PR title found, skipping');
+              return;
+            }
+
+            const prefix = prTitle.split(':')[0];
+            if (prefix !== 'deps' && prefix !== 'template') {
+              console.log('Not a prod/template update PR, skipping');
+              return;
+            }
+
+            const branch = await exec.getExecOutput('git branch --show-current');
+            if (!branch.stdout.startsWith('renovate-')) {
+              console.log('Not a renovate branch, skipping');
+              return;
+            }
+
+            const diffOutput = await exec.getExecOutput('git diff --name-only HEAD~1');
+            const diffFiles = diffOutput.stdout.split('\n');
+            if (diffFiles.find((f) => f.startsWith('.changeset'))) {
+              console.log('Changeset already exists, skipping');
+              return;
+            }
+
+            const files = diffFiles.filter((file) => file.includes('package.json'));
+            const packageNames = await getPackagesNames(files);
+            if (!packageNames.length) {
+              console.log('No package.json changes to published packages, skipping');
+              return;
+            }
+
+            const { stdout: shortHash } = await exec.getExecOutput(
+              'git rev-parse --short HEAD',
+            );
+            const fileName = `.changeset/renovate-${shortHash.trim()}.md`;
+
+            await createChangeset(fileName, prTitle, packageNames);
+            await exec.exec('git', ['add', fileName]);
+            await exec.exec('git commit -C HEAD --amend --no-edit');
+            await exec.exec('git push --force');

CONTRIBUTING.md

@@ -129,6 +129,16 @@ pnpm test:template greeter
 rm -fr ../tmp-greeter
 ```
 
+Snapshots in `templates` can be updated with the following command but note that manual clean up is necessary afterwards
+
+```shell
+# greeter being name of template
+pnpm test:template:updateSnapshot greeter
+
+# clean up temporary sibling directory
+rm -fr ../tmp-greeter
+```
+
 ### Running locally
 
 If you want to try out the **skuba** CLI on itself,

docs/cli/build.md

@@ -68,7 +68,7 @@ With esbuild, you can supply the following options:
 
 Compiles your project for compatibility with CommonJS and ES2015 modules.
 
-This is useful for building isomorphic npm packages, and serves as a replacement for [`smt build`].
+This is useful for building isomorphic npm packages.
 
 ```shell
 skuba build-package
@@ -90,7 +90,6 @@ See our [Buildkite guide] for more information.
 | :--------- | :----------------------------------------------- |
 | `--serial` | Force serial execution of compilation operations |
 
-[`smt build`]: ../migration-guides/seek-module-toolkit.md#building
 [`skuba configure`]: ./configure.md#skuba-configure
 [buildkite guide]: ../deep-dives/buildkite.md
 [compiler option]: https://www.typescriptlang.org/docs/handbook/compiler-options.html#compiler-options

docs/cli/run.md

@@ -7,8 +7,7 @@ nav_order: 3
 
 ---
 
-**skuba** lets you interactively run your TypeScript source code during development.
-The following commands are powered by [`ts-node`] and [`ts-node-dev`].
+**skuba** lets you interactively run your TypeScript source code during development, powered by [`tsx`].
 
 These commands are only intended to serve local development and simple scripting scenarios,
 as a TypeScript process can present substantial overhead at runtime.
@@ -26,7 +25,7 @@ skuba node src/some-cli-script.ts
 # ...
 ```
 
-or launches a [`ts-node`] REPL if a file is not provided:
+or launches a [`tsx`] REPL if a file is not provided:
 
 ```shell
 skuba node src/some-cli-script.ts
@@ -217,9 +216,8 @@ Execution should pause on the breakpoint until we hit `F5` or the `▶️` butto
 
 [`skuba build`]: ./build.md
 [`skuba-dive/register`]: https://github.com/seek-oss/skuba-dive#register
-[`ts-node-dev`]: https://github.com/whitecolor/ts-node-dev
-[`ts-node`]: https://github.com/typestrong/ts-node
 [`tsconfig-paths`]: https://github.com/dividab/tsconfig-paths
+[`tsx`]: https://github.com/privatenumber/tsx
 [express]: https://expressjs.com/
 [fastify]: https://www.fastify.io/
 [http server]: https://nodejs.org/docs/latest-v20.x/api/http.html#class-httpserver

docs/deep-dives/esbuild.md

@@ -47,7 +47,7 @@ There are a couple of gotchas when evaluating alternative build tools like esbui
 
   esbuild is not fully compatible with all existing `tsc` configurations,
   may lag behind TypeScript in language features,
-  and lacks rich interoperability with tooling like Jest (via `ts-jest`) and `ts-node`.
+  and lacks rich interoperability with tooling like Jest (via `ts-jest`).
 
   These issues can be mostly contained within a centralised toolkit like skuba,
   but it makes it more difficult to duct tape tools together on an ad-hoc basis,