From 2685266c4eef31bb0423b06bcfbdec206c7815a7 Mon Sep 17 00:00:00 2001 From: skuba <> Date: Thu, 14 Dec 2023 05:39:43 +0000 Subject: [PATCH] Deploy to GitHub Pages --- CHANGELOG.md | 2602 ++++++++++++++++++ CONTRIBUTING.md | 255 ++ _config.yml | 19 + docs/about.md | 78 + docs/cli/build.md | 99 + docs/cli/configure.md | 48 + docs/cli/help.md | 31 + docs/cli/index.md | 40 + docs/cli/init.md | 218 ++ docs/cli/lint.md | 82 + docs/cli/run.md | 217 ++ docs/cli/test.md | 42 + docs/deep-dives/arm64.md | 91 + docs/deep-dives/babel.md | 90 + docs/deep-dives/buildkite.md | 116 + docs/deep-dives/editors.md | 38 + docs/deep-dives/esbuild.md | 147 + docs/deep-dives/eslint.md | 103 + docs/deep-dives/github.md | 126 + docs/deep-dives/index.md | 6 + docs/deep-dives/jest.md | 78 + docs/development-api/buildkite.md | 36 + docs/development-api/git.md | 160 ++ docs/development-api/github.md | 193 ++ docs/development-api/index.md | 20 + docs/development-api/jest.md | 27 + docs/development-api/net.md | 36 + docs/logo.svg | 41 + docs/migration-guides/index.md | 6 + docs/migration-guides/seek-module-toolkit.md | 170 ++ docs/migration-guides/seek-skuba.md | 54 + docs/runtime-api/index.md | 31 + docs/templates/api.md | 999 +++++++ docs/templates/barebones.md | 402 +++ docs/templates/byo.md | 20 + docs/templates/index.md | 23 + docs/templates/package.md | 832 ++++++ docs/templates/worker.md | 1169 ++++++++ index.md | 72 + 39 files changed, 8817 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 _config.yml create mode 100644 docs/about.md create mode 100644 docs/cli/build.md create mode 100644 docs/cli/configure.md create mode 100644 docs/cli/help.md create mode 100644 docs/cli/index.md create mode 100644 docs/cli/init.md create mode 100644 docs/cli/lint.md create mode 100644 docs/cli/run.md create mode 100644 docs/cli/test.md create mode 100644 docs/deep-dives/arm64.md create mode 100644 docs/deep-dives/babel.md create mode 100644 docs/deep-dives/buildkite.md create mode 100644 docs/deep-dives/editors.md create mode 100644 docs/deep-dives/esbuild.md create mode 100644 docs/deep-dives/eslint.md create mode 100644 docs/deep-dives/github.md create mode 100644 docs/deep-dives/index.md create mode 100644 docs/deep-dives/jest.md create mode 100644 docs/development-api/buildkite.md create mode 100644 docs/development-api/git.md create mode 100644 docs/development-api/github.md create mode 100644 docs/development-api/index.md create mode 100644 docs/development-api/jest.md create mode 100644 docs/development-api/net.md create mode 100644 docs/logo.svg create mode 100644 docs/migration-guides/index.md create mode 100644 docs/migration-guides/seek-module-toolkit.md create mode 100644 docs/migration-guides/seek-skuba.md create mode 100644 docs/runtime-api/index.md create mode 100644 docs/templates/api.md create mode 100644 docs/templates/barebones.md create mode 100644 docs/templates/byo.md create mode 100644 docs/templates/index.md create mode 100644 docs/templates/package.md create mode 100644 docs/templates/worker.md create mode 100644 index.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..0d2c2da62 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2602 @@ +--- +nav_order: 98 +--- + +# Changelog + +--- + +## 7.4.0 + +### Minor Changes + +- **deps:** TypeScript 5.3 ([#1324](https://github.com/seek-oss/skuba/pull/1324)) + + This major release includes breaking changes. See the [TypeScript 5.3](https://devblogs.microsoft.com/typescript/announcing-typescript-5-3/) announcement for more information. + +- **init:** Default to `arm64` platform and `main` branch ([#1343](https://github.com/seek-oss/skuba/pull/1343)) + +- **init:** Support `main` default branch ([#1335](https://github.com/seek-oss/skuba/pull/1335)) + +- **lint:** Introduce skuba patches ([#1274](https://github.com/seek-oss/skuba/pull/1274)) + + This feature adds patches which are run only once on the `lint` or `format` commands following a skuba update. If your build pipeline is utilising [autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes), these changes will be pushed up automatically. + +### Patch Changes + +- **template/lambda-sqs-worker:** Remove `@aws-sdk/util-utf8-node` library ([#1326](https://github.com/seek-oss/skuba/pull/1326)) + +- **build, build-package, test:** Remove empty export synthesis for Jest setup files ([#1274](https://github.com/seek-oss/skuba/pull/1274)) + + [`isolatedModules`](https://www.typescriptlang.org/tsconfig#isolatedModules) was enabled by default in [v5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0). To ease this migration, the commands listed above were updated to dynamically synthesise an empty export for `jest.setup.ts` and `jest.setup.int.ts` files; this compatibility logic has now been removed. + + Up-to-date projects are unlikely to be affected, but you can easily add an empty export statement to placate the TypeScript compiler: + + ```console + jest.setup.ts(1,1): error TS1208: 'jest.setup.ts' cannot be compiled under '--isolatedModules' because it is considered a global script file. Add an import, export, or an empty 'export {}' statement to make it a module. + ``` + + ```diff + process.env.ENVIRONMENT = 'test'; + + + export {}; + ``` + +- **init:** Run Prettier after templating ([#1337](https://github.com/seek-oss/skuba/pull/1337)) + +- **template/lambda-sqs-worker-cdk:** Introduce bundling with esbuild, `--hotswap` and `--watch` ([#1321](https://github.com/seek-oss/skuba/pull/1321)) + + This template now uses the `aws_lambda_nodejs.NodejsFunction` construct which uses esbuild to bundle the Lambda function. This [reduces cold start time](https://aws.amazon.com/blogs/developer/reduce-lambda-cold-start-times-migrate-to-aws-sdk-for-javascript-v3/) and time to build on CI. + + The `--hotswap` and `--watch` options allow you to rapidly deploy your code changes to AWS, enhancing the developer feedback loop. This change introduces `deploy:hotswap` and `deploy:watch` scripts to the `package.json` manifest and a `Deploy Dev (Hotswap)` step to the Buildkite pipeline. Read more about watch and hotswap [on the AWS Developer Tools Blog](https://aws.amazon.com/blogs/developer/increasing-development-speed-with-cdk-watch/). + +## 7.3.1 + +### Patch Changes + +- **deps:** Prettier 3.1 ([#1314](https://github.com/seek-oss/skuba/pull/1314)) + + See the [release notes](https://prettier.io/blog/2023/11/13/3.1.0.html) for more information. + +- **init:** Fix `skuba.template.js` validation ([#1325](https://github.com/seek-oss/skuba/pull/1325)) + + This resolves an "Invalid function return type" error on `skuba init`. + +- **template:** Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +## 7.3.0 + +### Minor Changes + +- **Jest.mergePreset:** Propagate root-level configuration options to `projects` ([#1294](https://github.com/seek-oss/skuba/pull/1294)) + + [`Jest.mergePreset`](https://seek-oss.github.io/skuba/docs/development-api/jest.html#mergepreset) now propagates the `moduleNameMapper` and `transform` options from root-level configuration to the `projects` array. + + If you were referencing the base config in the `projects` array: + + ```ts + const baseConfig = Jest.mergePreset({ + // ... + }); + + export default { + ...baseConfig, + projects: [ + { + ...baseConfig, + displayName: 'unit', + setupFiles: ['/jest.setup.ts'], + testPathIgnorePatterns: ['\\.int\\.test\\.ts'], + }, + { + ...baseConfig, + displayName: 'integration', + setupFiles: ['/jest.setup.ts'], + testMatch: ['**/*.int.test.ts'], + }, + ], + }; + ``` + + You can replace it with the following: + + ```ts + export default Jest.mergePreset({ + // ... + projects: [ + { + displayName: 'unit', + setupFiles: ['/jest.setup.ts'], + testPathIgnorePatterns: ['\\.int\\.test\\.ts'], + }, + { + displayName: 'integration', + setupFiles: ['/jest.setup.ts'], + testMatch: ['**/*.int.test.ts'], + }, + ], + }); + ``` + + The `projects` option allows you to reuse a single Jest config file for different test types. View the [Jest documentation](https://jestjs.io/docs/configuration#projects-arraystring--projectconfig) for more information. + +- **Net.waitFor:** Use Docker Compose V2 ([#1281](https://github.com/seek-oss/skuba/pull/1281)) + + This function now executes `docker compose` under the hood as `docker-compose` stopped receiving updates in July 2023. See the [Docker manual](https://docs.docker.com/compose/migrate/) for more information. + +- **lint:** Add `prettier-plugin-packagejson` ([#1276](https://github.com/seek-oss/skuba/pull/1276)) + + This Prettier plugin sorts and formats your `package.json` file. + +### Patch Changes + +- **Git:** Handle non-root working directories in [`commitAllChanges`](https://seek-oss.github.io/skuba/docs/development-api/git.html#commitallchanges) ([#1269](https://github.com/seek-oss/skuba/pull/1269)) + +- **template/koa-rest-api:** Fix `app.test.ts` assertions ([#1282](https://github.com/seek-oss/skuba/pull/1282)) + + Previously, [custom `.expect((res) => {})` assertions](https://github.com/ladjs/supertest#expectfunctionres-) were incorrectly defined to return false rather than throw an error. The template has been updated to avoid this syntax, but the most straightforward diff to demonstrate the fix is as follows: + + ```diff + - await agent.get('/').expect(({ status }) => status !== 404); + + await agent.get('/').expect(({ status }) => expect(status).not.toBe(404)); + ``` + +- **template:** seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- **lint:** Resolve infinite autofix loop ([#1262](https://github.com/seek-oss/skuba/pull/1262)) + +- **GitHub:** Add working directory parameter to [`readFileChanges`](https://seek-oss.github.io/skuba/docs/development-api/github.html#readfilechanges) ([#1269](https://github.com/seek-oss/skuba/pull/1269)) + + The input `ChangedFiles` need to be evaluated against a working directory. While this is technically a breaking change, we have not found any external usage of the function in `SEEK-Jobs`. + + ```diff + - GitHub.readFileChanges(changedFiles) + + GitHub.readFileChanges(dir, changedFiles) + ``` + +- **lint:** Handle non-root working directories in autofix commits ([#1269](https://github.com/seek-oss/skuba/pull/1269)) + + Previously, `skuba lint` could produce surprising autofix commits if it was invoked in a directory other than the Git root. Now, it correctly evaluates its working directory in relation to the Git root, and will only commit file changes within its working directory. + +- **cli:** Migrate from Runtypes to Zod ([#1288](https://github.com/seek-oss/skuba/pull/1288)) + + The skuba CLI now uses Zod internally. This should not result in noticeable differences for consumers. + +- **template:** Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +## 7.2.0 + +### Minor Changes + +- **deps:** TypeScript 5.2 ([#1247](https://github.com/seek-oss/skuba/pull/1247)) + + This major release includes breaking changes. See the [TypeScript 5.2](https://devblogs.microsoft.com/typescript/announcing-typescript-5-2/) announcement for more information. + +### Patch Changes + +- **deps:** libnpmsearch 7 ([#1255](https://github.com/seek-oss/skuba/pull/1255)) + +- **deps:** Prettier 3.0.3 ([#1247](https://github.com/seek-oss/skuba/pull/1247)) + + See the [release notes](https://github.com/prettier/prettier/blob/main/CHANGELOG.md#303) for more information. + +- **deps:** sort-package-json 2.5.1 ([#1257](https://github.com/seek-oss/skuba/pull/1257)) + + This should resolve the following TypeScript compiler error: + + ```console + node_modules/@types/glob/index.d.ts(29,42): error TS2694: Namespace '"node_modules/minimatch/dist/cjs/index"' has no exported member 'IOptions'. + ``` + +## 7.1.1 + +### Patch Changes + +- **init:** Resolve directory path when patching Renovate config ([#1241](https://github.com/seek-oss/skuba/pull/1241)) + + This should fix the `Failed to patch Renovate config.` warning when creating a new repo. + +## 7.1.0 + +### Minor Changes + +- **format, lint:** Skip autofixing on Renovate branches when there is no open pull request ([#1226](https://github.com/seek-oss/skuba/pull/1226)) + + This prevents an issue where a Renovate branch can get stuck in the `Edited/Blocked` state without a pull request being raised. + +- **deps:** eslint-config-skuba 3 ([#1234](https://github.com/seek-oss/skuba/pull/1234)) + + This major upgrade brings in new rules from [typescript-eslint v6](https://typescript-eslint.io/blog/announcing-typescript-eslint-v6/). + + Diff patch from eslint-config-skuba 2 and eslint-config-skuba 3 + + ```diff + { + + '@typescript-eslint/array-type': '...', + + '@typescript-eslint/ban-tslint-comment': '...', + + '@typescript-eslint/class-literal-property-style': '...', + + '@typescript-eslint/consistent-generic-constructors': '...', + + '@typescript-eslint/consistent-indexed-object-style': '...', + + '@typescript-eslint/consistent-type-assertions': '...', + + 'dot-notation': '...', + + '@typescript-eslint/dot-notation': '...', + + '@typescript-eslint/no-base-to-string': '...', + + '@typescript-eslint/no-confusing-non-null-assertion': '...', + + '@typescript-eslint/no-duplicate-enum-values': '...', + + '@typescript-eslint/no-duplicate-type-constituents': '...', + + '@typescript-eslint/no-redundant-type-constituents': '...', + + '@typescript-eslint/no-unsafe-declaration-merging': '...', + + '@typescript-eslint/no-unsafe-enum-comparison': '...', + + '@typescript-eslint/prefer-for-of': '...', + + '@typescript-eslint/prefer-function-type': '...', + + '@typescript-eslint/prefer-nullish-coalescing': '...', + + '@typescript-eslint/prefer-optional-chain': '...', + + '@typescript-eslint/prefer-string-starts-ends-with': '...', + - 'no-extra-semi': '...', + - '@typescript-eslint/no-extra-semi': '...', + } + ``` + +- **format, lint:** Add `pnpm-lock.yaml` to `.prettierignore` ([#1225](https://github.com/seek-oss/skuba/pull/1225)) + +- **deps:** esbuild 0.19 ([#1236](https://github.com/seek-oss/skuba/pull/1236)) + +- **format, lint:** Switch distroless image from `nodejs` to `nodejs-debian11` ([#1224](https://github.com/seek-oss/skuba/pull/1224)) + + `skuba format` and `skuba lint` will now automatically switch your `gcr.io/distroless/nodejs:18` image to `gcr.io/distroless/nodejs18-debian11`. This is now the [recommended](https://github.com/GoogleContainerTools/distroless/blob/main/nodejs/README.md) base image for Node.js. + +### Patch Changes + +- **template/\*-rest-api:** Switch distroless image from `nodejs:18` to `nodejs18-debian11` ([#1224](https://github.com/seek-oss/skuba/pull/1224)) + +## 7.0.1 + +### Patch Changes + +- **test:** Fix Prettier snapshot formatting ([#1220](https://github.com/seek-oss/skuba/pull/1220)) + + Jest is not yet compatible with Prettier 3, causing snapshot updates to fail with the following error: + + ```typescript + TypeError: prettier.resolveConfig.sync is not a function + at runPrettier (node_modules/jest-snapshot/build/InlineSnapshots.js:308:30) + ``` + + Our [Jest preset](https://seek-oss.github.io/skuba/docs/development-api/jest.html#mergepreset) now implements custom formatting as a workaround until [jestjs/jest#14305](https://github.com/jestjs/jest/issues/14305) is resolved. + + If you do not use our preset, you can temporarily disable formatting in your `jest.config.ts` then manually run `skuba format` after updating snapshots: + + ```diff + export default { + + prettierPath: null, + } + ``` + +## 7.0.0 + +### Major Changes + +- **deps:** tsconfig-seek 2 ([#1175](https://github.com/seek-oss/skuba/pull/1175)) + + This change sets the [`noUncheckedIndexedAccess`](https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess) compiler option to `true` by default. + + This will flag possible issues with indexed access of arrays and records. + + Before: + + ```ts + const a: string[] = []; + const b = a[0]; + // ^? const b: string + ``` + + After: + + ```ts + const a: string[] = []; + const b = a[0]; + // ^? const b: string | undefined + ``` + + Unfortunately, this change is a double edged sword as your previous code which may look like this may now be invalid. + + ```ts + if (list.length === 3) { + const b = list[1]; + // ^? const b: string | undefined + } + ``` + + To address this you will need to also explicitly check the index you are accessing. + + ```ts + if (list.length === 3 && list[1]) { + const b = list[1]; + // ^? const b: string + } + ``` + + This may seem like overkill, however, when you consider that Javascript will also allow this it may make sense + + ```ts + const a: string[] = []; + a[1000] = 'foo'; + console.log(a.length); // 1001 + ``` + + You can override this setting in your project's `tsconfig.json` by setting it to false. + + ```json + { + "compilerOptions": { + "noUncheckedIndexedAccess": false + } + } + ``` + +- **deps:** Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + + Node.js 16 will reach end of life by September 2023. We have aligned our version support with [sku 12](https://github.com/seek-oss/sku/releases/tag/sku%4012.0.0). + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + +### Minor Changes + +- **deps:** esbuild 0.18 ([#1190](https://github.com/seek-oss/skuba/pull/1190)) + + `skuba build` will continue to infer `target` from `tsconfig.json` at this time. See the [esbuild release notes](https://github.com/evanw/esbuild/releases/tag/v0.18.0) for other details. + +- **format, lint:** Have Prettier respect `.gitignore` ([#1217](https://github.com/seek-oss/skuba/pull/1217)) + + This aligns with the behaviour of the [Prettier 3.0 CLI](https://prettier.io/blog/2023/07/05/3.0.0.html#cli). + +- **deps:** TypeScript 5.1 ([#1183](https://github.com/seek-oss/skuba/pull/1183)) + + This major release includes breaking changes. See the [TypeScript 5.1](https://devblogs.microsoft.com/typescript/announcing-typescript-5-1/) announcement for more information. + +- **deps:** Prettier 3.0 ([#1202](https://github.com/seek-oss/skuba/pull/1202)) + + See the [release notes](https://prettier.io/blog/2023/07/05/3.0.0.html) for more information. + +### Patch Changes + +- **template:** Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- **template/oss-npm-package:** Set `publishConfig.provenance` to `true` ([#1182](https://github.com/seek-oss/skuba/pull/1182)) + + See for more information. + +- **template/lambda-sqs-worker:** Change some info logs to debug ([#1178](https://github.com/seek-oss/skuba/pull/1178)) + + The "Function succeeded" log message was changed from `info` to `debug` to reduce the amount of unnecessary logs in production. The message will still be logged in dev environments but at a `debug` level. + +- **tsconfig:** Turn off [`noUnusedLocals`](https://www.typescriptlang.org/tsconfig#noUnusedLocals) and [`noUnusedParameters`](https://www.typescriptlang.org/tsconfig#noUnusedParameters) ([#1181](https://github.com/seek-oss/skuba/pull/1181)) + + [SEEK's ESLint config](https://github.com/seek-oss/eslint-config-seek) has a [rule](https://eslint.org/docs/latest/rules/no-unused-vars) which works for both function and types. We do not need both tools to do the same thing and ESLint has better support for ignoring files if needed. + +- **lint:** Resolve Git root before attempting to autofix ([#1215](https://github.com/seek-oss/skuba/pull/1215)) + +- **configure:** Resolve Git root before attempting to patch Renovate config ([#1215](https://github.com/seek-oss/skuba/pull/1215)) + +- **template/lambda-sqs-worker:** Bump aws-sdk-client-mock to 3.0.0 ([#1197](https://github.com/seek-oss/skuba/pull/1197)) + + AWS SDK v3.363.0 shipped with breaking type changes. + +## 6.2.0 + +### Minor Changes + +- **build, build-package:** Add a skuba config key named `assets` to copy assets to the output directory. ([#1163](https://github.com/seek-oss/skuba/pull/1163)) + + In your `package.json`: + + ```diff + { + "skuba": { + + "assets": [ + + "**/*.vocab/*translations.json" + + ], + "entryPoint": "src/index.ts", + "type": "package", + } + } + ``` + + This will instruct skuba to copy the files matching the list of globs to the output directory/ies, preserving the directory structure from the source: + + - for `skuba build-package` it will copy them to `lib-commonjs` and `lib-es2015` + - for `skuba build` it will copy them to `tsconfig.json#/compilerOptions.outDir` (`lib` by default) + +### Patch Changes + +- **template:** Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- **deps:** Bump @octokit dependencies ([#1174](https://github.com/seek-oss/skuba/pull/1174)) + + This should resolve the following compiler error: + + ```bash + error TS2339: Property 'annotations' does not exist on type '{}'. + ``` + +- **deps:** ts-jest ^29.1.0 ([#1166](https://github.com/seek-oss/skuba/pull/1166)) + + This resolves the following `skuba test` warning: + + ```console + Version 5.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <5.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions. + ``` + +- **template/\*-rest-api:** Remove Gantry `ignoreAlarms` override ([#1160](https://github.com/seek-oss/skuba/pull/1160)) + + This issue has been resolved in Gantry v2.2.0; see its [release notes](https://github.com/SEEK-Jobs/gantry/releases/tag/v2.2.0) for more information. + + ```diff + deployment: + - # SEEK-Jobs/gantry#488 + - ignoreAlarms: true + ``` + +## 6.1.0 + +### Minor Changes + +- **deps:** eslint-config-skuba 2 ([#1155](https://github.com/seek-oss/skuba/pull/1155)) + + This major upgrade removes [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) due to configuration issues experienced on non-React projects. + + Raise a GitHub issue or send us a Slack message if this negatively affects your project. + +- **start:** Add `http.Server` support ([#1159](https://github.com/seek-oss/skuba/pull/1159)) + + `skuba start` can now be used to create a live-reloading server for `http.Server` instances. See the [`skuba start` documentation](https://seek-oss.github.io/skuba/docs/cli/run.html#skuba-start) for more information. + +- **deps:** eslint-config-seek 11 ([#1155](https://github.com/seek-oss/skuba/pull/1155)) + + This major upgrade enforces [consistent type imports and exports](https://typescript-eslint.io/blog/consistent-type-imports-and-exports-why-and-how/). + + ```diff + - import { Context } from 'aws-lambda'; + + import type { Context } from 'aws-lambda'; + ``` + + `skuba format` will modify your imports and exports to be consistent with linting rules. These changes are automatically committed if you have [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) enabled on your project. + +## 6.0.2 + +### Patch Changes + +- **lint:** Avoid patching Renovate config when it already extends a `SEEK-Jobs` or `seekasia` preset ([#1132](https://github.com/seek-oss/skuba/pull/1132)) + +## 6.0.1 + +### Patch Changes + +- **lint:** Avoid committing `.npmrc` changes ([#1129](https://github.com/seek-oss/skuba/pull/1129)) + + `skuba lint` can automatically commit codegen changes if you have [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) enabled on your project. Previously we made sure to exclude a new `.npmrc` file from the commit, but we now exclude changes to an existing `.npmrc` too. + +## 6.0.0 + +### Major Changes + +- **deps:** Require Node.js 16.11+ ([#1124](https://github.com/seek-oss/skuba/pull/1124)) + + Node.js 14 will reach end of life by April 2023. + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + +### Minor Changes + +- **format, lint:** Prepend baseline SEEK `renovate-config` preset ([#1117](https://github.com/seek-oss/skuba/pull/1117)) + + `skuba format` and `skuba lint` will now automatically prepend an appropriate baseline preset if your project is configured with a `SEEK-Jobs` or `seekasia` remote: + + ```diff + // SEEK-Jobs + { + - extends: ['seek'], + + extends: ['local>seek-jobs/renovate-config', 'seek'], + } + + // seekasia + { + - extends: ['seek'], + + extends: ['local>seekasia/renovate-config', 'seek'], + } + ``` + + Renovate requires this new configuration to reliably access private SEEK packages. Adding the preset should fix recent issues where Renovate would open then autoclose pull requests, and report ⚠ Dependency Lookup Warnings ⚠. + + See [SEEK-Jobs/renovate-config](https://github.com/SEEK-Jobs/renovate-config) and [seekasia/renovate-config](https://github.com/seekasia/renovate-config) for more information. + +- **format, lint, template/\*-rest-api:** Set `keepAliveTimeout` to 31 seconds to prevent HTTP 502s ([#1111](https://github.com/seek-oss/skuba/pull/1111)) + + The default Node.js server keep-alive timeout is set to 5 seconds. However, the Gantry default ALB idle timeout is 30 seconds. This would lead to the occasional issues where the sidecar would throw `proxyStatus=502` errors. AWS recommends setting an application timeout larger than the ALB idle timeout. + + `skuba format` and `skuba lint` will now automatically append a keep-alive timeout to a typical `src/listen.ts`: + + ```diff + // With a listener callback + const listener = app.listen(config.port, () => { + const address = listener.address(); + }) + + + + listener.keepAliveTimeout = 31000; + + // Without a listener callback + - app.listen(config.port); + + const listener = app.listen(config.port); + + + + listener.keepAliveTimeout = 31000; + ``` + + A more detailed explanation can be found in the below links: + + 1. + 2. + +- **format, lint:** Bundle `eslint-plugin-yml` ([#1107](https://github.com/seek-oss/skuba/pull/1107)) + + [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) is now supported on `skuba format` and `skuba lint`. While the default configuration should be unobtrusive, you can opt in to stricter rules in your `.eslintrc.js`: + + ```diff + module.exports = { + extends: ['skuba'], + + overrides: [ + + { + + files: ['my/strict/config.yaml'], + + rules: { + + 'yml/sort-keys': 'error', + + }, + + }, + + ], + }; + ``` + + YAML files with non-standard syntax may fail ESLint parsing with this change. Gantry resource files should be excluded by default due to their custom templating syntax, and you can list additional exclusions in your `.eslintignore`. + +- **start:** Add Fastify support ([#1101](https://github.com/seek-oss/skuba/pull/1101)) + + `skuba start` can now be used to create a live-reloading server for Fastify based projects. See the [`skuba start` documentation](https://seek-oss.github.io/skuba/docs/cli/run.html#skuba-start) for more information. + +- **format, lint:** Configure ESLint for `{cjs,cts,mjs,mts}` files ([#1126](https://github.com/seek-oss/skuba/pull/1126)) + +- **lint:** Commit codegen updates ([#1078](https://github.com/seek-oss/skuba/pull/1078)) + + `skuba lint` can locally codegen updates to ignore files, module exports and Renovate configuration. These changes are now automatically committed if you have [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) enabled on your project. + +- **deps:** TypeScript 5.0 ([#1118](https://github.com/seek-oss/skuba/pull/1118)) + + This major release includes breaking changes. See the [TypeScript 5.0](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/) announcement for more information. + +### Patch Changes + +- **init:** Include baseline SEEK `renovate-config` preset ([#1117](https://github.com/seek-oss/skuba/pull/1117)) + +- **template/\*-package:** Require Node.js 16.11+ ([#1124](https://github.com/seek-oss/skuba/pull/1124)) + +- **lint:** Delete `Dockerfile-incunabulum` ([#1078](https://github.com/seek-oss/skuba/pull/1078)) + + `skuba lint` may have accidentally committed this internal file to source control in prior versions. It is now automatically removed if you have [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) enabled on your project. + +## 5.1.1 + +### Patch Changes + +- **lint:** Exclude internal files from autofix commits ([#1074](https://github.com/seek-oss/skuba/pull/1074)) + + `skuba lint` now avoids committing the following internal files in a [GitHub autofix](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes): + + - `.npmrc` + - `Dockerfile-incunabulum` + +## 5.1.0 + +### Minor Changes + +- **deps:** Prettier 2.8 ([#1056](https://github.com/seek-oss/skuba/pull/1056)) + + See the [release notes](https://prettier.io/blog/2022/11/23/2.8.0.html) for more information. + +- **deps:** TypeScript 4.9 ([#1046](https://github.com/seek-oss/skuba/pull/1046)) + + This major release includes breaking changes. See the [TypeScript 4.9](https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/) announcement for more information. + +### Patch Changes + +- **template/lambda-sqs-worker:** Declare `dd-trace` dependency ([#1051](https://github.com/seek-oss/skuba/pull/1051)) + + This resolves a `Runtime.ImportModuleError` that occurs if this transitive dependency is not installed: + + ```console + Runtime.ImportModuleError + Error: Cannot find module 'dd-trace' + ``` + + Alternatively, you can [configure the Datadog Serverless plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/#configuration-parameters) to bundle these dependencies via [Lambda layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html): + + ```diff + serverless.yml + + custom: + datadog: + - addLayers: false + + addLayers: true + ``` + + ```diff + package.json + + { + "dependencies": { + - "datadog-lambda-js: "x.y.z", + - "dd-trace: "x.y.z" + }, + "devDependencies": { + + "datadog-lambda-js: "x.y.z", + + "dd-trace: "x.y.z" + } + } + ``` + +- **template/lambda-sqs-worker\*:** Bump Node.js version to 18 ([#1049](https://github.com/seek-oss/skuba/pull/1049)) + + This release contains some breaking changes to the Lambda runtime such as the removal of AWS SDK V2 in favour of AWS SDK V3. See the [AWS Lambda Node.js 18.x runtime announcement](https://aws.amazon.com/blogs/compute/node-js-18-x-runtime-now-available-in-aws-lambda/) for more information. + +- **template:** Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- **template/lambda-sqs-worker\*:** Use single hyphen in `renovate-` branch name prefix ([#1050](https://github.com/seek-oss/skuba/pull/1050)) + +- **deps:** esbuild ~0.16.0 ([#1062](https://github.com/seek-oss/skuba/pull/1062)) + +- **template/\*-rest-api:** Replace `'{{.Environment}}'` with a custom `environment` Gantry value. ([#1065](https://github.com/seek-oss/skuba/pull/1065)) + +- **lint:** Require package.json to be sorted ([#1048](https://github.com/seek-oss/skuba/pull/1048)) + +## 5.0.1 + +### Patch Changes + +- **jest:** Fix `isolatedModules` transform config ([#1036](https://github.com/seek-oss/skuba/pull/1036)) + +- **deps:** eslint-config-skuba 1.2.0 ([#1035](https://github.com/seek-oss/skuba/pull/1035)) + + This introduces an autofix for the TS1205 compiler error. + +## 5.0.0 + +### Major Changes + +- **test:** Remove default `src` module alias ([#987](https://github.com/seek-oss/skuba/pull/987)) + + Our Jest preset automatically registers your `tsconfig.json` paths as module aliases, but would previously fall back to the `src` alias if the option was omitted or failed to load. This default has now been removed. + + This is not expected to affect most projects. If yours makes use of the `src` alias and its tests are now failing on imports like the following: + + ```typescript + import { app } from 'src/app.ts'; + ``` + + Ensure that you declare this path in a `tsconfig.json` located in your project root: + + ```diff + { + "compilerOptions": { + + "paths": { + + "src": ["src"] + + } + }, + "extends": "skuba/config/tsconfig.json" + } + ``` + +- **build, test:** Default to isolated modules ([#987](https://github.com/seek-oss/skuba/pull/987)) + + Our Jest and TypeScript presets now enable [`isolatedModules`](https://www.typescriptlang.org/tsconfig#isolatedModules) by default. Your Jest tests should start quicker, consume less resources, and no longer get stuck on pesky type errors. This should not compromise the type safety of your project as `skuba lint` is intended to type check all production and testing code. + + If your project contains files without imports and exports like `jest.setup.ts`, you can add an empty export statement to them to placate the TypeScript compiler: + + ```console + jest.setup.ts(1,1): error TS1208: 'jest.setup.ts' cannot be compiled under '--isolatedModules' because it is considered a global script file. Add an import, export, or an empty 'export {}' statement to make it a module. + ``` + + ```diff + process.env.ENVIRONMENT = 'test'; + + + export {}; + ``` + + If you previously enabled `isolatedModules` via the `globals` option in your Jest config, this is no longer functional due to syntax changes in ts-jest 29. You should be able to rely on our default going forward. `skuba configure` can attempt to clean up the stale option, or you can remove it from your `jest.config.ts` manually: + + ```diff + export default Jest.mergePreset({ + - globals: { + - 'ts-jest': { + - // seek-oss/skuba#626 + - isolatedModules: true, + - }, + - }, + // Rest of config + }); + ``` + + Isolated modules are incompatible with certain language features like `const enum`s. We recommend migrating away from such features as they are not supported by the broader ecosystem, including transpilers like Babel and esbuild. If your project is not yet ready for isolated modules, you can override the default in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + + "isolatedModules": false + }, + "extends": "skuba/config/tsconfig.json" + } + ``` + +### Minor Changes + +- **format:** Sort package.json ([#1016](https://github.com/seek-oss/skuba/pull/1016)) + +- **build:** Add experimental esbuild support ([#681](https://github.com/seek-oss/skuba/pull/681)) + + You can now build your project with [esbuild](https://esbuild.github.io/). Note that this integration is still experimental, only includes the bare minimum to supplant a basic `tsc`-based build, and is not guaranteed to match `tsc` output. See the [esbuild deep dive](https://seek-oss.github.io/skuba/docs/deep-dives/esbuild.html) for more information. + + To opt in, modify your `package.json`: + + ```diff + { + "skuba": { + + "build": "esbuild", + "template": null + } + } + ``` + +### Patch Changes + +- **configure:** Fix `tsconfig.json#/compilerOptions/lib` clobbering ([#1031](https://github.com/seek-oss/skuba/pull/1031)) + +- **template:** Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- **template/lambda-sqs-worker-cdk:** Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- **template/lambda-sqs-worker:** Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- **configure:** Fix package version lookups ([#974](https://github.com/seek-oss/skuba/pull/974)) + + This resolves the following error: + + ```console + Error: Package "xyz" does not have a valid package.json manifest + ``` + +- **configure:** Fix `jest.setup.js` clobbering ([#1031](https://github.com/seek-oss/skuba/pull/1031)) + +- **template/lambda-sqs-worker\*:** Adjust Buildkite pipelines for new `renovate--` branch name prefix ([#1022](https://github.com/seek-oss/skuba/pull/1022)) + + See the [pull request](https://github.com/seek-oss/rynovate/pull/76) that aligns our Renovate presets for more information. + +- **template:** Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- **template/koa-rest-api:** Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +## 4.4.1 + +### Patch Changes + +- **template/lambda-sqs-worker:** Switch to modern Datadog integration ([#965](https://github.com/seek-oss/skuba/pull/965)) + + Datadog's CloudWatch integration and the associated [`createCloudWatchClient`](https://github.com/seek-oss/datadog-custom-metrics/pull/177) function from [`seek-datadog-custom-metrics`](https://github.com/seek-oss/datadog-custom-metrics) have been deprecated. We recommend [Datadog's Serverless Framework Plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/) along with their first-party [datadog-lambda-js](https://github.com/DataDog/datadog-lambda-js) and [dd-trace](https://github.com/DataDog/dd-trace-js) npm packages. + +- **deps:** Drop `package-json` ([#962](https://github.com/seek-oss/skuba/pull/962)) + + This circumvents the [following TypeScript compilation error](https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/62111) on a clean install: + + ```console + Error: node_modules/@types/cacheable-request/index.d.ts(0,0): error TS2709: Cannot use namespace 'ResponseLike' as a type. + ``` + + If you run into this issue elsewhere in your project, you can temporarily work around it with a [resolution](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/) in your `package.json`: + + ```json + { + "resolutions": { + "@types/responselike": "1.0.0" + } + } + ``` + +- **template/koa-rest-api:** Drop `uuid` ([#964](https://github.com/seek-oss/skuba/pull/964)) + + V4 UUIDs can be generated using the built-in [`crypto.randomUUID()`](https://nodejs.org/docs/latest-v16.x/api/crypto.html#cryptorandomuuidoptions) function starting from Node.js 14.17. This is analogous to the [`Crypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID) Web API. + + ```diff + - import { v4 as randomUUID } from 'uuid'; + + import { randomUUID } from 'crypto'; + ``` + +## 4.4.0 + +### Minor Changes + +- **deps:** Jest 29 ([#953](https://github.com/seek-oss/skuba/pull/953)) + + This major release includes breaking changes. See the [announcement post](https://jestjs.io/blog/2022/08/25/jest-29) for more information. + + The `collectCoverageOnlyFrom` configuration option has been removed, and the default snapshot format has been simplified: + + ```diff + - Expected: \\"a\\" + + Expected: "a" + + - Object { + - Array [] + - } + + { + + [] + + } + ``` + +- **deps:** eslint-plugin-jest 27 ([#959](https://github.com/seek-oss/skuba/pull/959)) + + This major release includes breaking changes. See the [release note](https://github.com/jest-community/eslint-plugin-jest/releases/tag/v27.0.0) for more information. + + The `jest/no-alias-methods` rule is now [enforced](https://github.com/jest-community/eslint-plugin-jest/pull/1221) and [autofixed](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) to discourage usage of alias methods that will be [removed in Jest 30](https://github.com/facebook/jest/issues/13164). + + ```diff + - .toBeCalled() + + .toHaveBeenCalled() + ``` + +- **configure, init:** Format `package.json` with [sort-package-json](https://github.com/keithamus/sort-package-json) ([#951](https://github.com/seek-oss/skuba/pull/951)) + +- **deps:** TypeScript 4.8 ([#954](https://github.com/seek-oss/skuba/pull/954)) + + This major release includes breaking changes. See the [TypeScript 4.8](https://devblogs.microsoft.com/typescript/announcing-typescript-4-8/) announcement for more information. + +### Patch Changes + +- **configure, template:** Ignore linting on `.cdk.staging` directory ([#957](https://github.com/seek-oss/skuba/pull/957)) + +- **configure, template:** Ignore linting on `cdk.out` directory ([#940](https://github.com/seek-oss/skuba/pull/940)) + +- **template/\*-npm-package:** Use SSH scheme in repository URL ([#955](https://github.com/seek-oss/skuba/pull/955)) + + We have changed the templated format of the `package.json#repository/url` field. This may resolve `skuba release` errors that reference [Git password authentication is shutting down](https://github.blog/changelog/2021-08-12-git-password-authentication-is-shutting-down/) on the GitHub Blog. + + ```diff + - git+https://github.com/org/repo.git + + git+ssh://git@github.com/org/repo.git + ``` + +- **configure, template:** Allow `.idea` and `.vscode` ignore overrides ([#956](https://github.com/seek-oss/skuba/pull/956)) + + You can now append lines like `!.vscode/launch.json` to your ignore files to allow specific editor files to be committed, formatted and/or linted. + +## 4.3.1 + +### Patch Changes + +- **deps:** jest-watch-typeahead ^2.0.0 ([#925](https://github.com/seek-oss/skuba/pull/925)) + +- **template/\*-rest-api:** seek-jobs/gantry v2.0.0 ([#935](https://github.com/seek-oss/skuba/pull/935)) + +- **template/lambda-sqs-worker:** Remove tty disable from pipeline ([#918](https://github.com/seek-oss/skuba/pull/918)) + +- **test:** Prefer verbose failure message in execution error annotations ([#910](https://github.com/seek-oss/skuba/pull/910)) + +- **template/lambda-sqs-worker:** Remove unnecessary IAM permission ([#908](https://github.com/seek-oss/skuba/pull/908)) + +- **template:** Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- **template/\*-rest-api:** Fix Gantry documentation links ([#931](https://github.com/seek-oss/skuba/pull/931)) + +## 4.3.0 + +### Minor Changes + +- **test:** Add [`jest-watch-typeahead`](https://github.com/jest-community/jest-watch-typeahead) plugin ([#893](https://github.com/seek-oss/skuba/pull/893)) + + This enables typeahead suggestions when filtering by file or test name in watch mode. + +- **Git:** Add [fastForwardBranch](https://seek-oss.github.io/skuba/docs/development-api/git.html#fastforwardbranch) function ([#882](https://github.com/seek-oss/skuba/pull/882)) + +- **deps:** TypeScript 4.7 ([#877](https://github.com/seek-oss/skuba/pull/877)) + + This major release includes breaking changes. See the [TypeScript 4.7](https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/) announcement for more information. + + While ECMAScript Module support for Node.js is now stable in TypeScript, other aspects of our toolchain have not caught up yet; notably, Node.js still lacks stable APIs for Jest to implement its usual suite of mocking capabilities. We are holding off on recommending existing repositories to make the switch and on providing reference implementations via our templates. As it stands, migrating from CJS to ESM is still an arduous exercise in rewriting import statements and restructuring mocks and test suites at the bare minimum. + +- **GitHub:** Add functions to create and upload verified commits using the GitHub GraphQL API ([#882](https://github.com/seek-oss/skuba/pull/882)) + + See our [GitHub API documentation](https://seek-oss.github.io/skuba/docs/development-api/github.html) for more information. + +- **deps:** Prettier 2.7 ([#899](https://github.com/seek-oss/skuba/pull/899)) + + See the [release notes](https://prettier.io/blog/2022/06/14/2.7.0.html) for more information. + +### Patch Changes + +- **test:** Improve file detection for GitHub annotations ([#885](https://github.com/seek-oss/skuba/pull/885)) + +- **deps:** package-json ^7.0.0 ([#903](https://github.com/seek-oss/skuba/pull/903)) + + Resolves [SNYK-JS-GOT-2932019](https://security.snyk.io/vuln/SNYK-JS-GOT-2932019). + +- **template/\*-rest-api:** seek-jobs/gantry v1.8.1 ([#887](https://github.com/seek-oss/skuba/pull/887)) + +- **template/\*:** Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- **lint:** Use GitHub GraphQL API to upload verified autofix commits ([#882](https://github.com/seek-oss/skuba/pull/882)) + +- **template:** Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +## 4.2.2 + +### Patch Changes + +- **template/lambda-sqs-worker:** Avoid mutation of logger context ([#879](https://github.com/seek-oss/skuba/pull/879)) + + We now perform a shallow copy when retrieving the logger context from `AsyncLocalStorage`. + + ```diff + - mixin: () => loggerContext.getStore() ?? {}, + + mixin: () => ({ ...loggerContext.getStore() }), + ``` + +## 4.2.1 + +### Patch Changes + +- **template/private-npm-package:** Use `npm2` build agent queue ([#843](https://github.com/seek-oss/skuba/pull/843)) + +- **lint, test:** Set timeout for Buildkite and GitHub integrations ([#835](https://github.com/seek-oss/skuba/pull/835)) + + Transient network failures can impact annotations and autofixes. We now specify a 30 second timeout for these integration features to prevent them from hanging and indefinitely preoccupying your build agents. + +- **template:** Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- **cli:** Make warning logs more verbose ([#826](https://github.com/seek-oss/skuba/pull/826)) + +- **template/lambda-sqs-worker:** Change deployment method to `direct` ([#868](https://github.com/seek-oss/skuba/pull/868)) + +- **template/koa-rest-api:** Use [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#asynchronous-context-tracking) to track logger context ([#864](https://github.com/seek-oss/skuba/pull/864)) + + We now employ [RequestLogging.createContextStorage](https://github.com/seek-oss/koala/blob/master/src/requestLogging/README.md#context-logging) to thread logging context through the middleware stack of your Koa application. This enables use of a singleton `logger` instance instead of manually propagating Koa context and juggling `rootLogger`s and `contextLogger`s. + + Before: + + ```typescript + import createLogger from '@seek/logger'; + import Koa, { Context } from 'koa'; + import { RequestLogging } from 'seek-koala'; + + const rootLogger = createLogger(); + + const contextLogger = (ctx: Context) => + rootLogger.child(RequestLogging.contextFields(ctx)); + + const app = new Koa().use((ctx) => { + rootLogger.info('Has no context'); + + contextLogger(ctx).info('Has context'); + }); + ``` + + After: + + ```typescript + import createLogger from '@seek/logger'; + import Koa from 'koa'; + import { RequestLogging } from 'seek-koala'; + + const { createContextMiddleware, mixin } = + RequestLogging.createContextStorage(); + + const contextMiddleware = createContextMiddleware(); + + const logger = createLogger({ mixin }); + + const app = new Koa().use(contextMiddleware).use((ctx) => { + logger.info('Has context'); + }); + ``` + +- **template/lambda-sqs-worker:** Use [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#asynchronous-context-tracking) to track logger context ([#871](https://github.com/seek-oss/skuba/pull/871)) + + We now employ this Node.js API to thread logging context through the handler of your Lambda function. This enables use of a singleton `logger` instance instead of manually propagating Lambda context and juggling `rootLogger`s and `contextLogger`s, and is equivalent to #864. + + Before: + + ```typescript + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const rootLogger = createLogger(); + + const contextLogger = ({ awsRequestId }: Context) => + rootLogger.child({ awsRequestId }); + + const handler = async (_event: unknown, ctx: Context) => { + rootLogger.info('Has no context'); + + contextLogger(ctx).info('Has context'); + }; + ``` + + After: + + ```typescript + import { AsyncLocalStorage } from 'async_hooks'; + + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const loggerContext = new AsyncLocalStorage<{ awsRequestId: string }>(); + + const logger = createLogger({ + mixin: () => ({ ...loggerContext.getStore() }), + }); + + const handler = (_event: unknown, { awsRequestId }: Context) => + loggerContext.run({ awsRequestId }, async () => { + logger.info('Has context'); + }); + ``` + +- **template/lambda-sqs-worker\*:** Bump Node.js version to 16 ([#862](https://github.com/seek-oss/skuba/pull/862)) + +- **build-package, lint:** Improve detection of SEEK Buildkite queues for serial execution ([#829](https://github.com/seek-oss/skuba/pull/829)) + +- **lint:** Detect and autofix ESLint warnings ([#844](https://github.com/seek-oss/skuba/pull/844)) + +- **lint:** Skip autofixing when ESLint reports no fixable issues ([#844](https://github.com/seek-oss/skuba/pull/844)) + +- **format, lint:** Avoid unnecessary template literals ([#849](https://github.com/seek-oss/skuba/pull/849)) + + We now automatically convert unnecessary template literals into single-quoted strings for consistency. + +- **deps:** Jest 28 ([#856](https://github.com/seek-oss/skuba/pull/856)) + + This major release includes breaking changes. See the [announcement post](https://jestjs.io/blog/2022/04/25/jest-28) for more information. + +## 4.2.0 + +### Minor Changes + +- **deps:** TypeScript 4.6 ([#811](https://github.com/seek-oss/skuba/pull/811)) + + This major release includes breaking changes. See the [TypeScript 4.5](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5/) and [TypeScript 4.6](https://devblogs.microsoft.com/typescript/announcing-typescript-4-6/) announcements for more information. + +- **lint:** Autofix in CI ([#800](https://github.com/seek-oss/skuba/pull/800)) + + `skuba lint` can now automatically push ESLint and Prettier autofixes. This eases adoption of linting rule changes and automatically resolves issues arising from a forgotten `skuba format`. + + You'll need to configure your CI environment to support this feature. See our [GitHub autofixes](https://seek-oss.github.io/skuba/docs/deep-dives/github.html#github-autofixes) documentation to learn more. + +- **deps:** ESLint 8 + eslint-config-seek 9 ([#806](https://github.com/seek-oss/skuba/pull/806)) + + These major upgrades bundle new parser and plugin versions. See the [ESLint 8 guide](https://eslint.org/docs/8.0.0/user-guide/migrating-to-8.0.0) and [eslint-config-seek 9 release](https://github.com/seek-oss/eslint-config-seek/releases/tag/v9.0.0) for more details on the underlying changes. + + We've introduced new linting rules like [@typescript-eslint/no-unsafe-argument](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unsafe-argument.md), and resolved the following installation warning: + + ```console + babel-eslint is now @babel/eslint-parser. This package will no longer receive updates. + ``` + + If you wish to relax some of the new rules, [extend](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files) your `.eslintrc.js` config: + + ```javascript + module.exports = { + extends: ['skuba'], + rules: { + // Demote new TypeScript ESLint rule from 'error' to 'warn'. + '@typescript-eslint/no-unsafe-argument': 'warn', + }, + }; + ``` + +### Patch Changes + +- **template/lambda-sqs-worker-cdk:** Fix progress configuration in `cdk.json` ([#797](https://github.com/seek-oss/skuba/pull/797)) + +- **Jest.mergePreset:** Allow additional props via type parameter ([#806](https://github.com/seek-oss/skuba/pull/806)) + +- **Git.currentBranch:** Add helper function ([#804](https://github.com/seek-oss/skuba/pull/804)) + +- **test:** Strip ANSI escape codes from error messages for GitHub annotations ([#825](https://github.com/seek-oss/skuba/pull/825)) + +- **Git.commitAllChanges:** Skip commit and return `undefined` when there are no changes ([#804](https://github.com/seek-oss/skuba/pull/804)) + +- **template/oss-npm-package:** Lock down GitHub workflow permissions ([#807](https://github.com/seek-oss/skuba/pull/807)) + + This aligns with [OpenSSF guidance](https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions). + +- **template:** Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- **template:** Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- **Git.getOwnerAndRepo:** Support reading from CI environment variables ([#804](https://github.com/seek-oss/skuba/pull/804)) + +- **Git.getHeadCommitMessage:** Add helper function ([#804](https://github.com/seek-oss/skuba/pull/804)) + +- **template/\*-rest-api:** Avoid alternative syntax for ENV instructions ([#823](https://github.com/seek-oss/skuba/pull/823)) + + Omitting the `=` symbol in ENV instructions [is discouraged and may be disallowed in future](https://docs.docker.com/engine/reference/builder/#env). + + ```diff + - ENV NODE_ENV production + + ENV NODE_ENV=production + ``` + +- **template/oss-npm-package:** Pin GitHub action versions ([#805](https://github.com/seek-oss/skuba/pull/805)) + +- **template/\*-rest-api:** seek-jobs/gantry v1.7.0 ([#824](https://github.com/seek-oss/skuba/pull/824)) + +## 4.1.1 + +### Patch Changes + +- **template:** Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- **template:** Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- **format, lint:** Suppress `eslint-plugin-react` warning ([#786](https://github.com/seek-oss/skuba/pull/786)) + + ```console + Warning: React version was set to "detect" in eslint-plugin-react settings, but the "react" package is not installed. Assuming latest React version for linting. + ``` + +- **deps:** Prettier 2.6 ([#792](https://github.com/seek-oss/skuba/pull/792)) + + See the [release notes](https://prettier.io/blog/2022/03/16/2.6.0.html) for more information. + +- **node:** Throw unhandled rejections under Node.js 14 ([#777](https://github.com/seek-oss/skuba/pull/777)) + + When a rejected promise is left unhandled in Node.js 14, it simply logs a warning. This caused `skuba node` to effectively swallow such failures and report a process exit code of 0. We now override this behaviour with [`--unhandled-rejections=throw`](https://nodejs.org/docs/latest-v16.x/api/cli.html#--unhandled-rejectionsmode) to predictably fail with a non-zero exit code across supported Node.js versions. + +- **template/\*-rest-api:** seek-jobs/gantry v1.6.2 ([#778](https://github.com/seek-oss/skuba/pull/778)) + +## 4.1.0 + +### Minor Changes + +- **node, start:** Load environment variables from `.env` file ([#774](https://github.com/seek-oss/skuba/pull/774)) + +- **deps:** ts-node ^10.5.0 ([#764](https://github.com/seek-oss/skuba/pull/764)) + + This major release includes breaking changes. If your project uses a complex `ts-node` configuration either directly or on top of `skuba node` and `skuba start`, see the [changelog](https://github.com/TypeStrong/ts-node/releases/tag/v10.0.0) for more information. + +### Patch Changes + +- **template:** skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- **template/lambda-sqs-worker:** Remove `variablesResolutionMode` ([#768](https://github.com/seek-oss/skuba/pull/768)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Starting with v3.0, the "variablesResolutionMode" option is now useless. You can safely remove it from the configuration + More info: https://serverless.com/framework/docs/deprecations/#VARIABLES_RESOLUTION_MODE + ``` + +- **template/\*-rest-api:** Ignore deployment alarms and ECR scanning ([#773](https://github.com/seek-oss/skuba/pull/773)) + +- **configure:** Fix `@seek/seek-module-toolkit` migration guide link ([#762](https://github.com/seek-oss/skuba/pull/762)) + +- **template/lambda-sqs-worker-cdk:** Add `NODE_ENV=production` to environment variables ([#763](https://github.com/seek-oss/skuba/pull/763)) + +- **template/lambda-sqs-worker:** Add `NODE_ENV=production` to environment variables ([#763](https://github.com/seek-oss/skuba/pull/763)) + +- **deps:** ts-node-dev ^2.0.0-0 ([#764](https://github.com/seek-oss/skuba/pull/764)) + +- **template/lambda-sqs-worker:** Move environment variables to `provider.environment` to reduce repetition ([#767](https://github.com/seek-oss/skuba/pull/767)) + +## 4.0.0 + +### Major Changes + +- **deps:** Require Node.js 14.18+ ([#760](https://github.com/seek-oss/skuba/pull/760)) + + Node.js 12 will reach end of life by April 2022. The `semantic-release` package and stable `--enable-source-maps` flag necessitate this new minimum version. + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + +- **deps:** semantic-release ^19.0.0 ([#757](https://github.com/seek-oss/skuba/pull/757)) + + Resolves [SNYK-JS-MARKED-2342073](https://app.snyk.io/vuln/SNYK-JS-MARKED-2342073) and [SNYK-JS-MARKED-2342082](https://app.snyk.io/vuln/SNYK-JS-MARKED-2342082). + + This may alleviate the following `skuba release` error: + + ```console + [semantic-release] › ✖ EGHNOPERMISSION The GitHub token doesn't allow to push on the repository owner/repo. + The user associated with the GitHub token (https://github.com/semantic-release/github/blob/master/README.md#github-authentication) configured in the GH_TOKEN or GITHUB_TOKEN environment variable must allows to push to the repository owner/repo. + ``` + +- **template:** Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +### Patch Changes + +- **template/lambda-sqs-worker:** Disable `tty` on deploy step ([#753](https://github.com/seek-oss/skuba/pull/753)) + + Serverless Framework v3 renders progress spinners on interactive terminals. We recommend disabling [tty](https://github.com/buildkite-plugins/docker-compose-buildkite-plugin#tty-optional-run-only) in CI/CD for cleaner log output. + +- **template/lambda-sqs-worker:** serverless ^3.0.0 ([#748](https://github.com/seek-oss/skuba/pull/748)) + +- **template/lambda-sqs-worker:** Replace `custom.env` configuration with `params` ([#752](https://github.com/seek-oss/skuba/pull/752)) + + You can now define environment specific variables using the new Serverless parameters feature. See for more details. + +- **template/\*-rest-api:** seek-jobs/gantry v1.6.1 ([#759](https://github.com/seek-oss/skuba/pull/759)) + +- **template/lambda-sqs-worker:** Remove `provider.lambdaHashingVersion` ([#751](https://github.com/seek-oss/skuba/pull/751)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Setting "20201221" for "provider.lambdaHashingVersion" is no longer effective as new hashing algorithm is now used by default. You can safely remove this property from your configuration. + ``` + +- **deps:** eslint-config-skuba 1.0.14 ([#758](https://github.com/seek-oss/skuba/pull/758)) + + This disables the `tsdoc/syntax` ESLint rule in tests for compatibility with `/** @jest-environment env */` directives. + +- **deps:** isomorphic-git ^1.11.1 ([#750](https://github.com/seek-oss/skuba/pull/750)) + + Resolves [SNYK-JS-SIMPLEGET-2361683](https://security.snyk.io/vuln/SNYK-JS-SIMPLEGET-2361683). + +## 3.17.2 + +### Patch Changes + +- **init:** Fix GitHub template cloning ([#739](https://github.com/seek-oss/skuba/pull/739)) + + This resolves the following error when cloning a project template from GitHub: + + ```typescript + UnknownTransportError: Git remote "git@github.com:owner/repo.git" uses an unrecognized transport protocol: "ssh" + ``` + +- **template/lambda-sqs-worker:** Remove qualifier from smoke test invocation ([#743](https://github.com/seek-oss/skuba/pull/743)) + + Previously, this template's smoke test hook specified a `$LATEST` qualifier in its `Lambda.Invoke` API call. AWS authorised the call based on the unqualified Lambda ARN in our `serverless.yml` IAM policy, but will stop doing so after April 2022. + + To avoid deployment failures, remove the qualifier in `src/hooks.ts`. An unqualified call is equivalent to targeting `$LATEST`. + + ```diff + - Qualifier: '$LATEST', + + Qualifier: undefined, + ``` + +- **node:** Register `tsconfig-paths` in REPL ([#745](https://github.com/seek-oss/skuba/pull/745)) + + This resolves the following error: + + ```typescript + Error: Cannot find module '/node_modules/skuba/lib/register' + Require stack: + - internal/preload + ``` + +## 3.17.1 + +### Patch Changes + +- **deps:** ts-jest ^27.1.2 ([#729](https://github.com/seek-oss/skuba/pull/729)) + + This resolves the following import issue in older 27.0.x versions of `ts-jest`: + + ```console + TypeError: pathsToModuleNameMapper is not a function + ``` + +- **test:** Restore Node.js 12 compatibility ([#730](https://github.com/seek-oss/skuba/pull/730)) + + This resolves the following error in Node.js 12 environments: + + ```typescript + Object.entries(parsedConfig.options.paths ?? DEFAULT_PATHS).flatMap( + ^ + + SyntaxError: Unexpected token '?' + ``` + + Note that Node.js 12 will reach its end of life in May 2022. + +## 3.17.0 + +### Minor Changes + +- **template/koa-rest-api:** Add opt-in OpenTelemetry support ([#706](https://github.com/seek-oss/skuba/pull/706)) + +- **deps:** Prettier 2.5 ([#701](https://github.com/seek-oss/skuba/pull/701)) + + See the [release notes](https://prettier.io/blog/2021/11/25/2.5.0.html) for more information. + +- **node, start:** Register `tsconfig-paths` ([#678](https://github.com/seek-oss/skuba/pull/678)) + + You can now define module aliases other than `src` for local development and scripting. Specify these through the `paths` compiler option in your `tsconfig.json`: + + ```jsonc + // tsconfig.json + { + "compilerOptions": { + "baseUrl": ".", + "paths": { + "src": ["src"] + } + } + } + ``` + +- **GitHub.buildNameFromEnvironment:** Export helper function ([#676](https://github.com/seek-oss/skuba/pull/676)) + +- **jest:** Support `tsconfig.json` paths ([#698](https://github.com/seek-oss/skuba/pull/698)) + + Module aliases other than `src` are now supported in `skuba test`. Our Jest preset includes a dynamic `moduleNameMapper` that reads the `paths` compiler option from your `tsconfig.json`. + +- **git:** Export helper functions ([#689](https://github.com/seek-oss/skuba/pull/689)) + +- **test:** Add GitHub check run annotations ([#648](https://github.com/seek-oss/skuba/pull/648)) + + `skuba test` can now automatically annotate GitHub commits when you [propagate CI environment variables and a GitHub API token](https://github.com/seek-oss/skuba/blob/master/docs/deep-dives/github.md#github-annotations). These annotations also appear inline with code under the “Files changed” tab in pull requests. + +- **GitHub.getPullRequestNumber:** Export helper function ([#690](https://github.com/seek-oss/skuba/pull/690)) + +- **GitHub.putIssueComment:** Export helper function ([#690](https://github.com/seek-oss/skuba/pull/690)) + + This enables use cases like a persistent bot comment at the top of a pull request a la Changesets that reflects the current status of a CI check. + +- **GitHub.enabledFromEnvironment:** Export helper function ([#676](https://github.com/seek-oss/skuba/pull/676)) + +### Patch Changes + +- **GitHub.createCheckRun:** Support `text` parameter ([#673](https://github.com/seek-oss/skuba/pull/673)) + +- **template:** Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- **template:** serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- **test:** Fix `ts-jest` imports ([#715](https://github.com/seek-oss/skuba/pull/715)) + + This resolves the following warning: + + ```console + Replace any occurrences of "ts-jest/utils" with just "ts-jest". + ``` + + If you're using the `mocked` utility from `ts-jest`, switch over to the built-in Jest function: + + ```diff + import git from 'isomorphic-git'; + - import { mocked } from 'ts-jest'; + + jest.mock('isomorphic-git'); + + - mocked(git.commit).mockResolvedValue(''); + + jest.mocked(git.commit).mockResolvedValue(''); + ``` + +- **template/lambda-sqs-worker-cdk:** Migrate to AWS CDK v2 ([#714](https://github.com/seek-oss/skuba/pull/714)) + +- **node, start:** Deregister `source-map-support` ([#679](https://github.com/seek-oss/skuba/pull/679)) + + `ts-node` takes care of this for us. + +- **template/lambda-sqs-worker-cdk:** Fix docker-compose volume mount and deploy output ([#695](https://github.com/seek-oss/skuba/pull/695)) + +- **Jest.mergePreset:** Allow `displayName` and `projects` ([#648](https://github.com/seek-oss/skuba/pull/648)) + +## 3.16.2 + +### Patch Changes + +- **format, lint:** Skip reading unsupported Prettier files into memory ([#662](https://github.com/seek-oss/skuba/pull/662)) + +- **format, lint:** Fix file descriptor warnings ([#664](https://github.com/seek-oss/skuba/pull/664)) + + This resolves the following warning when processing files that Prettier cannot parse: + + ```console + (node:123) Warning: File descriptor 456 closed but not opened in unmanaged mode + ``` + +## 3.16.1 + +### Patch Changes + +- **deps:** Include `@octokit/types` ([#660](https://github.com/seek-oss/skuba/pull/660)) + + This should fix the following compilation error: + + ``` + node_modules/skuba/lib/api/github/checkRun.d.ts(2,45): error TS2339: Property 'POST /repos/{owner}/{repo}/check-runs' does not exist on type 'Endpoints'. + ``` + +## 3.16.0 + +### Minor Changes + +- **GitHub.createCheckRun:** Add development API for writing annotations ([#625](https://github.com/seek-oss/skuba/pull/625)) + +- **lint:** Add GitHub check run annotations ([#625](https://github.com/seek-oss/skuba/pull/625)) + + `skuba lint` can now automatically annotate GitHub commits when you [propagate Buildkite environment variables and a GitHub API token](https://github.com/seek-oss/skuba/blob/master/docs/deep-dives/github.md#github-annotations). These annotations also appear inline with code under the “Files changed” tab in pull requests. + +- **format, lint:** Enable ESLint caching ([#645](https://github.com/seek-oss/skuba/pull/645)) + + ESLint now writes to a local `.eslintcache` store. This speeds up subsequent runs of `skuba format` and `skuba lint` as they can skip unchanged files. + +- **deps:** eslint-config-skuba 1.0.12 ([#623](https://github.com/seek-oss/skuba/pull/623)) + + This adds a couple new linting rules: + + - [jest/prefer-expect-resolves](https://github.com/jest-community/eslint-plugin-jest/blob/v25.2.2/docs/rules/prefer-expect-resolves.md) + - [jest/prefer-to-be](https://github.com/jest-community/eslint-plugin-jest/blob/v25.2.2/docs/rules/prefer-to-be.md) + + Run `skuba format` to automatically align your code with these rules. + +- **format, lint:** Synchronise ignore files ([#646](https://github.com/seek-oss/skuba/pull/646)) + + `skuba format` and `skuba lint` will now keep `.eslintignore`, `.gitignore` and `.prettierignore` in sync. This automatically applies new exclusions like `.eslintcache` without the need for a manual `skuba configure`. + +### Patch Changes + +- **template:** Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- **template/lambda-sqs-worker:** Switch to ARM64 architecture ([#640](https://github.com/seek-oss/skuba/pull/640)) + + These are a bit cheaper and a bit faster than x86 Lambdas: + + + The underlying Lambda architecture should be invisible to typical TypeScript Lambdas. + +- **template:** Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- **template:** seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- **deps:** typescript 4.4.4 ([#616](https://github.com/seek-oss/skuba/pull/616)) + +- **start:** Add a `?` placeholder for unnamed function arguments ([#647](https://github.com/seek-oss/skuba/pull/647)) + +- **deps:** Relax ranges ([#622](https://github.com/seek-oss/skuba/pull/622)) + + Projects can now upgrade to new Prettier and TypeScript patches and `ts-node-dev` minors without us having to cut a new release. + +- **template:** hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- **template/lambda-sqs-worker:** Remove `pino.Logger` indirection ([#624](https://github.com/seek-oss/skuba/pull/624)) + +- **template:** @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- **template:** Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- **template:** Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +## 3.15.2 + +### Patch Changes + +- **Jest.mergePreset:** Do not mutate underlying defaults ([#595](https://github.com/seek-oss/skuba/pull/595)) + + `Jest.mergePreset` no longer mutates the internal `jest-preset` object. Subsequent calls to `Jest.mergePreset` will no longer return results merged in from previous calls. + + **Warning:** If you rely on mutating the core `jest-preset` object for later access, this is a _Breaking Change_. + +- **template/lambda-sqs-worker:** Convert Serverless `isProduction` config value to boolean ([#602](https://github.com/seek-oss/skuba/pull/602)) + + This avoids potentially surprising behaviour if you try to make use of this config value in a context that tests for truthiness. The boolean is still correctly applied as a string `seek:env:production` tag value. + +- **node, start:** Handle void function inputs and outputs ([#597](https://github.com/seek-oss/skuba/pull/597)) + + When running a function entrypoint, `skuba node` and `skuba start` now handle an omitted request body the same as an empty JSON array of arguments `[]`. The function can also return `undefined` to omit a response body. + +- **template/lambda-sqs-worker:** Opt in to [new Serverless variables resolver](https://www.serverless.com/framework/docs/deprecations/#NEW_VARIABLES_RESOLVER) ([#601](https://github.com/seek-oss/skuba/pull/601)) + +- **lint:** Use worker threads when running `--serial`ly ([#607](https://github.com/seek-oss/skuba/pull/607)) + + This aims to reduce the memory footprint of `skuba lint --serial`. ESLint and Prettier are now run in worker threads so their memory can be more readily freed on thread exit. + +- **template:** Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- **configure, init:** Drop dependency on external Git installation ([#599](https://github.com/seek-oss/skuba/pull/599)) + + We now interface with `isomorphic-git` internally, which ensures compatibility and affords finer control over log output. + +- **format, lint:** Run Prettier serially on files ([#606](https://github.com/seek-oss/skuba/pull/606)) + + This aims to reduce the memory footprint of `skuba lint`. + +- **template:** seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- **Jest.mergePreset:** Allow configuration of test environment ([#592](https://github.com/seek-oss/skuba/pull/592)) + + [Jest's `testEnvironment`](https://jestjs.io/docs/configuration#testenvironment-string) can now be passed to `Jest.mergePreset`: + + ```ts + export default Jest.mergePreset({ + testEnvironment: 'jsdom', + }); + ``` + +- **template/lambda-sqs-worker:** Fail fast on invalid Serverless config ([#605](https://github.com/seek-oss/skuba/pull/605)) + +- **template:** pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- **node, start:** Print function entrypoint parameters ([#600](https://github.com/seek-oss/skuba/pull/600)) + + When running a function entrypoint, `skuba node` and `skuba start` now print the function and parameter names as a usage hint: + + ```javascript + yarn skuba node 'src/api/buildkite/annotate.ts#annotate' + // annotate (markdown, opts) + // listening on port 9001 + + curl --data '["_Hello there_", {}]' --include localhost:9001 + ``` + +## 3.15.1 + +### Patch Changes + +- **configure:** Tone down Dockerfile `outDir` processing ([#585](https://github.com/seek-oss/skuba/pull/585)) + + This avoids rewriting sequences like "distroless" as "libroless". + +- **template:** Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- **build-package, lint:** Handle worker thread errors more gracefully ([#583](https://github.com/seek-oss/skuba/pull/583)) + + The worker threads now correctly propagate an exit code and log errors instead of triggering an `UnhandledPromiseRejectionWarning`. + +- **format, lint:** Limit Prettier to 25 parallel file I/O operations ([#584](https://github.com/seek-oss/skuba/pull/584)) + + This should alleviate file descriptor issues that are not handled by `graceful-fs` such as `EBADF: bad file description, close`. + +## 3.15.0 + +### Minor Changes + +- **lint:** Run ESLint and Prettier in worker threads ([#548](https://github.com/seek-oss/skuba/pull/548)) + + This reduces the number of Node.js processes spawned by `skuba lint`. We've also been able to significantly enhance our logging output as a result, particularly when the `--debug` flag is supplied. + +- **build-package, lint:** Add `--serial` flag ([#556](https://github.com/seek-oss/skuba/pull/556)) + + This explicitly disables concurrent command execution. + + Propagating the `BUILDKITE` environment variable to these commands no longer constrains their concurrency. If you were relying on this behaviour to reduce resource contention on undersized Buildkite agents, update your commands to pass in the flag: + + ```diff + - build-package + + build-package --serial + + - lint + + lint --serial + ``` + + See our [Buildkite guide](https://github.com/seek-oss/skuba/tree/master/docs/deep-dives/buildkite.md) for more information. + +- **node:** Run REPL in process ([#534](https://github.com/seek-oss/skuba/pull/534)) + + This avoids creating a separate Node.js process just to run the REPL. + +- **Buildkite.annotate:** Add development API for writing annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- **format:** Execute ESLint with `--report-unused-disable-directives` ([#512](https://github.com/seek-oss/skuba/pull/512)) + + `skuba format` will now flag unused disable directives, and will [automatically remove](https://eslint.org/blog/2021/06/whats-coming-in-eslint-8.0.0#unused-disable-directives-are-now-fixable) them once ESLint v8 is released. + +- **deps:** Prettier 2.4 ([#507](https://github.com/seek-oss/skuba/pull/507)) + + This includes TypeScript 4.4 support. See the [release notes](https://prettier.io/blog/2021/09/09/2.4.0.html) for more information. + +- **deps:** TypeScript 4.4 ([#497](https://github.com/seek-oss/skuba/pull/497)) + + This major release includes breaking changes. See the [announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-4-4/) for more information. + + Note that new syntax in TypeScript 4.4 will only be supported by `skuba format` and `skuba lint` once ESLint v8 is released. + +- **format:** Run ESLint and Prettier in process ([#539](https://github.com/seek-oss/skuba/pull/539)) + + This eliminates the overhead of spinning up separate Node.js processes. We've also been able to significantly enhance our logging output as a result, particularly when the `--debug` flag is supplied. + +- **build:** Remove experimental Babel support ([#513](https://github.com/seek-oss/skuba/pull/513)) + + There's limited upside to switching to [Babel-based builds](https://github.com/seek-oss/skuba/tree/master/docs/deep-dives/babel.md) for backend use cases, and it would be difficult to guarantee backwards compatibility with existing `tsconfig.json`-based configuration. Dropping Babel dependencies reduces our package size and resolves [SNYK-JS-SETVALUE-1540541](https://app.snyk.io/vuln/SNYK-JS-SETVALUE-1540541). + +- **lint:** Support Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + + `skuba lint` can now output issues as Buildkite annotations. + + See our [Buildkite guide](https://github.com/seek-oss/skuba/tree/master/docs/deep-dives/buildkite.md) for more information. + +### Patch Changes + +- **template:** pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- **template:** Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- **template:** serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- **template/lambda-sqs-worker\*:** Prime dev ECR cache in Buildkite pipeline ([#503](https://github.com/seek-oss/skuba/pull/503)) + + This should result in faster "Deploy Dev" times as the ECR cache will already be warm. + +- **template:** seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- **template:** Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- **template/\*-rest-api:** Suggest using a secure header middleware ([#579](https://github.com/seek-oss/skuba/pull/579)) + +- **template/lambda-sqs-worker-cdk:** Run "Test, Lint & Build" step in prod ([#503](https://github.com/seek-oss/skuba/pull/503)) + + This reduces our dependence on a dev environment to successfully deploy to prod. + +- **build-package, lint:** Simplify logging prefix ([#535](https://github.com/seek-oss/skuba/pull/535)) + +- **Jest.mergePreset:** Allow `watchPathIgnorePatterns` ([#555](https://github.com/seek-oss/skuba/pull/555)) + +- **build-package, lint:** Limit max concurrency to CPU core count ([#540](https://github.com/seek-oss/skuba/pull/540)) + +- **template:** Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +## 3.14.4 + +### Patch Changes + +- **template:** @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) +- **template:** seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) +- **deps:** @types/jest ^27.0.0 ([#489](https://github.com/seek-oss/skuba/pull/489)) +- **template/\*-rest-api:** Parameterise AWS region ([#488](https://github.com/seek-oss/skuba/pull/488)) + +## 3.14.3 + +### Patch Changes + +- **template:** seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) +- **template:** Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) +- **template:** Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) +- **template/lambda-sqs-worker:** Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) +- **template/greeter:** Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) +- **template/lambda-sqs-worker-cdk:** Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) +- **template:** Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- **deps:** ts-node-dev 1.1.8 ([#462](https://github.com/seek-oss/skuba/pull/462)) +- **template/express-rest-api:** Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#471](https://github.com/seek-oss/skuba/pull/471)) +- **template/\*-rest-api:** Reduce app boilerplate ([#478](https://github.com/seek-oss/skuba/pull/478)) +- **template:** Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- **template:** Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) +- **configure, init:** Deduplicate dependencies ([#470](https://github.com/seek-oss/skuba/pull/470)) +- **template:** Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) +- **template/lambda-sqs-worker-\*:** Build once upfront ([#477](https://github.com/seek-oss/skuba/pull/477)) + + This employs Buildkite [artifacts](https://buildkite.com/docs/pipelines/artifacts) to share compiled code with each subsequent deployment step. + +- **deps:** TypeScript 4.3.5 ([#463](https://github.com/seek-oss/skuba/pull/463)) +- **template/koa-rest-api:** Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#471](https://github.com/seek-oss/skuba/pull/471)) + +## 3.14.2 + +### Patch Changes + +- **deps:** TypeScript 4.3.4 ([#455](https://github.com/seek-oss/skuba/pull/455)) +- **deps:** prettier 2.3.2 ([#460](https://github.com/seek-oss/skuba/pull/460)) +- **template/koa-rest-api:** Include success message in smoke test body ([#459](https://github.com/seek-oss/skuba/pull/459)) +- **template/greeter:** Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) +- **template/lambda-sqs-worker:** Set `memorySize` for smoke test hook to 128 MiB ([#457](https://github.com/seek-oss/skuba/pull/457)) +- **template/koa-rest-api:** Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) +- **template/express-rest-api:** Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) +- **template:** Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) +- **deps:** ts-node-dev 1.1.7 ([#461](https://github.com/seek-oss/skuba/pull/461)) + + Resolves [CVE-2021-33623](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-33623). + +## 3.14.1 + +### Patch Changes + +- **deps:** Prettier 2.3.1 ([#446](https://github.com/seek-oss/skuba/pull/446)) + + `skuba format` and `skuba lint` now support TypeScript 4.3 syntax. See the full Prettier [changelog](https://github.com/prettier/prettier/blob/4b4499a0d86220f4c393dc93140e2bac7992d0f4/CHANGELOG.md#%E2%80%8B231) for more information. + +- **template:** pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) +- **template:** seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +## 3.14.0 + +### Minor Changes + +- **deps:** Prettier 2.3 ([#434](https://github.com/seek-oss/skuba/pull/434)) + + This release may require reformatting of your code. If your lint step is failing in CI, run your format command locally then push the resulting changes. + + ```shell + yarn format + ``` + +- **deps:** TypeScript 4.3 ([#434](https://github.com/seek-oss/skuba/pull/434)) + + This major release includes breaking changes. See the [announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-4-3/) for more information. + + `skuba format` and `skuba lint` will error on new TypeScript 4.3 syntax that are not yet supported by Prettier. + +- **deps:** Jest 27 ([#433](https://github.com/seek-oss/skuba/pull/433)) + + This major release includes breaking changes. See the Jest 27 [blog post](https://jestjs.io/blog/2021/05/25/jest-27) and [changelog](https://github.com/facebook/jest/blob/v27.0.3/CHANGELOG.md) for more information. + +### Patch Changes + +- **Jest.mergePreset:** Type `snapshotSerializers` option ([#436](https://github.com/seek-oss/skuba/pull/436)) +- **template:** Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) +- **template/lambda-sqs-worker-cdk:** Always build before deploy ([#428](https://github.com/seek-oss/skuba/pull/428)) + + This prevents stale compiled code from being cached and deployed from ECR. + +- **template/koa-rest-api:** Log returned error responses ([#430](https://github.com/seek-oss/skuba/pull/430)) +- **template:** Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- **deps:** fs-extra ^10.0.0 ([#424](https://github.com/seek-oss/skuba/pull/424)) + +## 3.13.1 + +### Patch Changes + +- **template/\*-npm-package:** Add `yarn commit` script ([#418](https://github.com/seek-oss/skuba/pull/418)) +- **template/lambda-sqs-worker-cdk:** Trim CDK deployment output ([#423](https://github.com/seek-oss/skuba/pull/423)) +- **template:** @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) +- **deps:** typescript 4.2.4 ([#376](https://github.com/seek-oss/skuba/pull/376)) + + See the [announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-4-2/) for features and breaking changes. Note that the currently bundled version of Prettier does not support `abstract` construct signatures. + +- **template/lambda-sqs-worker-cdk:** Fix npm token in Buildkite pipeline ([#423](https://github.com/seek-oss/skuba/pull/423)) + +## 3.13.0 + +### Minor Changes + +- **template/lambda-sqs-worker-cdk:** Add new template ([#395](https://github.com/seek-oss/skuba/pull/395)) +- **format, lint:** Support `--debug` flag ([#367](https://github.com/seek-oss/skuba/pull/367)) +- **template:** Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +### Patch Changes + +- **template/lambda-sqs-worker:** Use new `serverless.yml#/provider/iam` grouping ([#357](https://github.com/seek-oss/skuba/pull/357)) + + The `provider.iamRoleStatements` property [will be removed in Serverless v3](https://github.com/serverless/serverless/blob/v2.25.1/docs/deprecations.md#grouping-iam-settings-under-provideriam). + +- **template/lambda-sqs-worker:** serverless-plugin-canary-deployments ^0.5.0 ([#394](https://github.com/seek-oss/skuba/pull/394)) + + The plugin now patches in CodeDeploy permissions to your `iamRoleStatements`, so you can clean your `serverless.yml`: + + ```diff + - - Action: codedeploy:PutLifecycleEventHookExecutionStatus + - Effect: Allow + - Resource: !Sub arn:aws:codedeploy:${AWS::Region}:${AWS::AccountId}:deploymentgroup:*/${WorkerLambdaFunctionDeploymentGroup} + ``` + +- **template:** runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) +- **template/koa-rest-api:** Fix ineffectual smoke test ([#361](https://github.com/seek-oss/skuba/pull/361)) +- **template:** Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) +- **deps:** semantic-release ^17.3.8 ([#353](https://github.com/seek-oss/skuba/pull/353)) + + Resolves [SNYK-JS-MARKED-1070800](https://app.snyk.io/vuln/SNYK-JS-MARKED-1070800). + +- **template/\*-rest-api:** Fail Gantry build if ECR scanning reports vulnerabilities ([#373](https://github.com/seek-oss/skuba/pull/373)) +- **template:** runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) +- **template/koa-rest-api:** Remove awkward request body from GET test ([#362](https://github.com/seek-oss/skuba/pull/362)) +- **deps:** ejs ^3.1.6 ([#354](https://github.com/seek-oss/skuba/pull/354)) + + Resolves [SNYK-JS-EJS-1049328](https://app.snyk.io/vuln/SNYK-JS-EJS-1049328). + +- **init:** Mention GitHub repo creation ([#382](https://github.com/seek-oss/skuba/pull/382)) + + skuba doesn't have access to GitHub credentials to create a repository on your behalf. The CLI now makes it clearer that you should create an empty GitHub repository. + +- **template/lambda-sqs-worker:** Remove custom Serverless variable syntax ([#350](https://github.com/seek-oss/skuba/pull/350)) + + `serverless@2.3.0` bundled native support for CloudFormation pseudo parameters. This even works with arbitrary logical IDs like `!Sub ${WorkerLambdaFunctionDeploymentGroup}`. + +- **deps:** runtypes ^6.0.0 ([#406](https://github.com/seek-oss/skuba/pull/406)) +- **deps:** ts-node-dev 1.1.6 ([#371](https://github.com/seek-oss/skuba/pull/371)) +- **Jest:** Expose `testTimeout` in `Jest.mergePreset` options ([#389](https://github.com/seek-oss/skuba/pull/389)) +- **template/lambda-sqs-worker:** Use new `serverless.yml#/package/patterns` property ([#415](https://github.com/seek-oss/skuba/pull/415)) + + The `package.exclude` and `package.include` properties [will be removed in Serverless v3](https://github.com/serverless/serverless/blob/v2.32.0/docs/deprecations.md#new-way-to-define-packaging-patterns). + +- **deps:** concurrently ^6.0.0 ([#379](https://github.com/seek-oss/skuba/pull/379)) +- **deps:** typescript 4.1.5 ([#355](https://github.com/seek-oss/skuba/pull/355)) +- **configure:** Rewrite `dist => lib` in `serverless.yml`s ([#387](https://github.com/seek-oss/skuba/pull/387)) +- **template/\*-rest-api:** Move Gantry region config to plugin options ([#374](https://github.com/seek-oss/skuba/pull/374)) +- **template:** Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +## 3.12.2 + +### Patch Changes + +- **node:** Fix `src` module alias registration ([#344](https://github.com/seek-oss/skuba/pull/344)) + +## 3.12.1 + +### Patch Changes + +- **node, start:** Propagate `process.argv` ([#341](https://github.com/seek-oss/skuba/pull/341)) + + Passing command-line arguments into a script now works as expected: + + ```bash + yarn skuba node src/script.ts arg1 arg2 arg3 + ``` + +- **node:** Support Node.js inspector options when running a script ([#341](https://github.com/seek-oss/skuba/pull/341)) + + Passing an [inspector option](https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options) for script debugging now works as expected: + + ```bash + yarn skuba node --inspect-brk src/script.ts + ``` + +- **build-package, lint:** Run serially on Buildkite ([#343](https://github.com/seek-oss/skuba/pull/343)) + + These commands now run their underlying processes serially when the `BUILDKITE` environment variable is set. This reduces the chance of resource exhaustion on smaller instance sizes but slows down builds. + +- **template/koa-rest-api:** Tidy custom Koa types ([#336](https://github.com/seek-oss/skuba/pull/336)) +- **test:** Exclude Jest `config.ts` files from coverage ([#340](https://github.com/seek-oss/skuba/pull/340)) +- **template:** seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +## 3.12.0 + +### Minor Changes + +- **node:** Add command ([#298](https://github.com/seek-oss/skuba/pull/298)) + + `skuba node` lets you run a TypeScript source file, or open a REPL if none is provided: + + - `skuba node src/some-cli-script.ts` + - `skuba node` + + This automatically registers a `src` module alias for ease of local development. For example, you can run a prospective `src/someLocalCliScript.ts` without having to register a module alias resolver: + + ```typescript + // This `src` module alias just works under `skuba node` and `skuba start` + import { rootLogger } from 'src/framework/logging'; + ``` + + ```bash + yarn skuba node src/someLocalCliScript + ``` + + If you use this alias in your production code, your entry point(s) will need to import a runtime module alias resolver like [`skuba-dive/register`](https://github.com/seek-oss/skuba-dive#register). For example, your `src/app.ts` may look like: + + ```typescript + // This must be imported directly within the `src` directory + import 'skuba-dive/register'; + + // You can use the `src` module alias after registration + import { rootLogger } 'src/framework/logging'; + ``` + +- **node, start:** Support function entry points ([#301](https://github.com/seek-oss/skuba/pull/301)) + + You can now specify an entry point that targets an exported function: + + ```bash + skuba start --port 12345 src/app.ts#handler + ``` + + This starts up a local HTTP server that you can POST arguments to: + + ```bash + curl --data '["event", {"awsRequestId": "123"}]' --include localhost:12345 + ``` + + You may find this useful to run Lambda function handlers locally. + +- **configure, help, init:** Check for newer skuba versions ([#300](https://github.com/seek-oss/skuba/pull/300)) + + skuba will now print an upgrade command if there is a newer version available. You can now use a global installation without worrying that you're setting up new repos using outdated templates. + +### Patch Changes + +- **template/lambda-sqs-worker:** Simplify Buildkite pipeline ([#314](https://github.com/seek-oss/skuba/pull/314)) +- **deps:** typescript 4.1.3 ([#297](https://github.com/seek-oss/skuba/pull/297)) +- **template/koa-rest-api:** Type context ([#299](https://github.com/seek-oss/skuba/pull/299)) +- **lint:** Detect incomplete templating ([#315](https://github.com/seek-oss/skuba/pull/315)) +- **template:** Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) +- **template/lambda-sqs-worker:** Add smoke test ([#328](https://github.com/seek-oss/skuba/pull/328)) + + This brings back versioned functions along with `serverless-prune-plugin` to control Lambda storage consumption. By default we configure `serverless-plugin-canary-deployments` for an instantaneous switch once the smoke test has passed, but this can be customised as necessary. + +- **configure:** Add `test:watch` script ([#303](https://github.com/seek-oss/skuba/pull/303)) +- **configure:** Migrate `jest.config.js` to `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) +- **template:** Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- **template/\*-rest-api:** Supply custom autoscaling policy ([#322](https://github.com/seek-oss/skuba/pull/322)) +- **init:** Pick random server port ([#333](https://github.com/seek-oss/skuba/pull/333)) +- **template/lambda-sqs-worker:** Add `start` script ([#301](https://github.com/seek-oss/skuba/pull/301)) +- **template/\*-rest-api:** Explicitly register `listen.ts` ([#332](https://github.com/seek-oss/skuba/pull/332)) +- **deps:** Bump caret ranges ([#309](https://github.com/seek-oss/skuba/pull/309)) + + Resolves [SNYK-JS-SEMVERREGEX-1047770](https://app.snyk.io/vuln/SNYK-JS-SEMVERREGEX-1047770). + +- **template/koa-rest-api:** Limit request logging to errors ([#294](https://github.com/seek-oss/skuba/pull/294)) +- **start:** Improve support for non-HTTP server entry points ([#298](https://github.com/seek-oss/skuba/pull/298)) + + You can now run arbitrary TypeScript files without them exiting on a `You must export callback or requestListener` error. + +- **configure, init:** Improve error messaging in offline scenarios ([#305](https://github.com/seek-oss/skuba/pull/305)) +- **template/\*-rest-api:** Clarify health checks and smoke tests ([#332](https://github.com/seek-oss/skuba/pull/332)) +- **template/lambda-sqs-worker:** Require deployment bucket ([#330](https://github.com/seek-oss/skuba/pull/330)) +- **pkg:** Remove ESM from skuba's bundle ([#296](https://github.com/seek-oss/skuba/pull/296)) + + This simplifies our bundle; Node.js and skuba's CLI have always defaulted to CommonJS anyway. + +- **start:** Support `src` module alias ([#298](https://github.com/seek-oss/skuba/pull/298)) +- **node, start:** Support `--port` option ([#301](https://github.com/seek-oss/skuba/pull/301)) +- **configure:** Remove `package-lock.json` ([#324](https://github.com/seek-oss/skuba/pull/324)) +- **test:** Set `NODE_ENV=test` ([#326](https://github.com/seek-oss/skuba/pull/326)) + + This is something that Jest itself does in its `bin/jest`. + +- **template:** Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) +- **start:** Support source maps ([#298](https://github.com/seek-oss/skuba/pull/298)) +- **template/lambda-sqs-worker:** Lock Serverless `lambdaHashingVersion` ([#329](https://github.com/seek-oss/skuba/pull/329)) + + This gets rid of the following warning when deploying: + + ```text + Deprecation warning: Starting with next major version, default value of provider.lambdaHashingVersion will be equal to "20201221" + More Info: https://www.serverless.com/framework/docs/deprecations/#LAMBDA_HASHING_VERSION_V2 + ``` + +- **deps:** Bump minor and patch versions ([#331](https://github.com/seek-oss/skuba/pull/331)) +- **configure:** Ensure workspaced `package.json` is private ([#306](https://github.com/seek-oss/skuba/pull/306)) +- **template/\*-rest-api:** Use Distroless runtime images ([#316](https://github.com/seek-oss/skuba/pull/316)) +- **template:** Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +## 3.11.0 + +### Minor Changes + +- **deps:** TypeScript 4.1 ([#269](https://github.com/seek-oss/skuba/pull/269)) + + This includes formatting and linting support for new syntax features. + + See the [release notes](https://devblogs.microsoft.com/typescript/announcing-typescript-4-1) for more information. + +- **lint:** Check for unused `eslint-disable` directives ([#272](https://github.com/seek-oss/skuba/pull/272)) + + `skuba lint` will now report on unnecessary `eslint-disable` directives that should be removed: + + ```diff + - /* eslint-disable-next-line new-cap */ + const camelCase = 'no problems here'; + ``` + +### Patch Changes + +- **template:** Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) +- **deps:** babel-plugin-macros ^3.0.0 ([#277](https://github.com/seek-oss/skuba/pull/277)) +- **deps:** ts-node-dev 1.1.1 ([#288](https://github.com/seek-oss/skuba/pull/288)) + + If you see the following error on `npm install`: + + ```bash + npm ERR! enoent ENOENT: no such file or directory, chmod '.../node_modules/ts-node-dev/lib\bin.js' + ``` + + Try updating npm: + + ```bash + npm -g install npm + ``` + +- **template:** Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) +- **build:** Fix `--out-dir requires filenames` error on experimental Babel builds ([#291](https://github.com/seek-oss/skuba/pull/291)) +- **deps:** eslint-config-skuba 1.0.10 ([#284](https://github.com/seek-oss/skuba/pull/284)) +- **deps:** prettier 2.2.1 ([#278](https://github.com/seek-oss/skuba/pull/278)) +- **start:** Support default export of Express listener ([#289](https://github.com/seek-oss/skuba/pull/289)) +- **template/express-rest-api:** Fix server listener and port ([#289](https://github.com/seek-oss/skuba/pull/289)) +- **template:** Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +## 3.10.2 + +### Patch Changes + +- **deps:** typescript 4.0.5 ([#241](https://github.com/seek-oss/skuba/pull/241)) +- **template:** Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) +- **deps:** semantic-release ^17.2.3 ([#263](https://github.com/seek-oss/skuba/pull/263)) +- **template/lambda-sqs-worker:** Remove redundant `ecr` plugin ([#259](https://github.com/seek-oss/skuba/pull/259)) +- **template:** seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) +- **template/koa-rest-api:** seek-koala ^5.0.0 ([#260](https://github.com/seek-oss/skuba/pull/260)) +- **template:** supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) +- **template:** runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) +- **template:** @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) +- **template:** Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) +- **template/lambda-sqs-worker:** Default to unversioned Lambdas ([#245](https://github.com/seek-oss/skuba/pull/245)) + + Our baseline template does not do canary deployments, and this makes it less likely to hit code storage limits down the road. + +- **template:** seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +## 3.10.1 + +### Patch Changes + +- **deps:** Pin ts-node-dev 1.0.0-pre.63 ([#239](https://github.com/seek-oss/skuba/pull/239)) + + This fixes errors on `npm install` on macOS and Linux. Yarn 1.x was unaffected by this issue. + +- **template:** seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +## 3.10.0 + +### Minor Changes + +- **start:** Support default exports ([#90](https://github.com/seek-oss/skuba/pull/90)) + + `skuba start` now works with a Koa application exported with `export default`. This syntax is preferred over `export =` for compatibility with tooling such as Babel. + +- **start:** Support [Node.js debugging options](https://nodejs.org/en/docs/guides/debugging-getting-started/) ([#230](https://github.com/seek-oss/skuba/pull/230)) + + [`skuba start`](https://github.com/seek-oss/skuba/blob/master/docs/cli/run.md#skuba-start) now accepts `--inspect` and `--inspect-brk` options. This allows you to attach a debugger to the process. + +- **init:** Redesign base prompt ([#234](https://github.com/seek-oss/skuba/pull/234)) + + The base prompt no longer mandates a team name and supports copy+paste. + +### Patch Changes + +- **template/lambda-sqs-worker:** Remove region from subscription example snippet ([#223](https://github.com/seek-oss/skuba/pull/223)) +- **template:** supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) +- **template/koa-rest-api:** hot-shots ^8.0.0 ([#217](https://github.com/seek-oss/skuba/pull/217)) +- **deps:** Bump caret ranges ([#235](https://github.com/seek-oss/skuba/pull/235)) +- **template:** Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- **template:** docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) +- **template:** Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) +- **template/greeter:** Align Dockerfile stages ([#219](https://github.com/seek-oss/skuba/pull/219)) +- **template/koa-rest-api:** Avoid `export =` syntax ([#90](https://github.com/seek-oss/skuba/pull/90)) +- **deps:** normalize-package-data ^3.0.0 ([#231](https://github.com/seek-oss/skuba/pull/231)) +- **template:** Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) +- **template:** Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +## 3.9.2 + +### Patch Changes + +- **deps:** prettier 2.1.2 ([#207](https://github.com/seek-oss/skuba/pull/207)) +- **template:** docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) +- **template/lambda-sqs-worker:** serverless ^2.0.0 ([#203](https://github.com/seek-oss/skuba/pull/203)) +- **deps:** eslint-config-skuba 1.0.8 ([#214](https://github.com/seek-oss/skuba/pull/214)) + + This patch should reduce `@typescript-eslint` noise across JS files. + +- **template/\*-rest-api:** seek-jobs/gantry v1.2.6 ([#211](https://github.com/seek-oss/skuba/pull/211)) +- **deps:** typescript 4.0.3 ([#208](https://github.com/seek-oss/skuba/pull/208)) +- **template/koa-rest-api:** Remove `koa-cluster` ([#206](https://github.com/seek-oss/skuba/pull/206)) + + While Fargate environments with <= 1 vCPU appear to expose multiple threads, + clustering does not improve performance and only serves to increase idle memory usage. + + You may add `koa-cluster` yourself if you have a CPU-bound workload running on multiple vCPUs. + Even in such cases, it may be better to run multiple tasks with one vCPU each rather than one task with multiple vCPUs. + +- **template:** Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) +- **deps:** Bump minor ranges ([#214](https://github.com/seek-oss/skuba/pull/214)) + +## 3.9.1 + +### Patch Changes + +- **start:** Allow execution despite typechecking errors ([#201](https://github.com/seek-oss/skuba/pull/201)) +- **template/lambda-sqs-worker:** Include `aws-sdk` in bundle ([#198](https://github.com/seek-oss/skuba/pull/198)) +- **build:** Support `tsc --build` flag ([#200](https://github.com/seek-oss/skuba/pull/200)) +- **configure:** Remove direct `eslint-config-skuba` and `semantic-release` dependencies ([#195](https://github.com/seek-oss/skuba/pull/195)) +- **build-package, lint:** Colour code subprocess output ([#190](https://github.com/seek-oss/skuba/pull/190)) +- **build-package, lint:** Clean up error output ([#190](https://github.com/seek-oss/skuba/pull/190)) +- **configure:** Clean up select `lint:xxx` scripts in `package.json` ([#196](https://github.com/seek-oss/skuba/pull/196)) +- **test:** Resolve `@typescript-eslint/typescript-estree` warnings with TypeScript 4.0: ([#202](https://github.com/seek-oss/skuba/pull/202)) + + ```text + WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree. + ``` + +- **configure:** Use TypeScript 4.0 node factory API ([#193](https://github.com/seek-oss/skuba/pull/193)) +- **lint:** [eslint-plugin-jest ^24.0.0](https://github.com/jest-community/eslint-plugin-jest/releases/v24.0.0) ([#202](https://github.com/seek-oss/skuba/pull/202)) + + This enables a few additional linting rules by default. + +## 3.9.0 + +### Minor Changes + +- **deps:** [TypeScript 4.0](https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/) ([#188](https://github.com/seek-oss/skuba/pull/188)) + + This includes compatible versions of ESLint, Jest and Prettier. You may need to reformat your code with `yarn skuba format`. + + TypeScript 4.0 is largely backward compatible, but you may see errors if you [`delete` a required property](https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/#operands-for-delete-must-be-optional): + + ```typescript + const fn = (arg: { prop: string }) => { + delete arg.prop; + // ~~~~~~ + // error! The operand of a 'delete' operator must be optional. + }; + ``` + +- **lint:** Allow incremental typechecking ([#188](https://github.com/seek-oss/skuba/pull/188)) + +### Patch Changes + +- **configure:** Fix bad import ([#187](https://github.com/seek-oss/skuba/pull/187)) +- **template:** Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) +- **template/\*-npm-package:** Retain comments out of the box ([#184](https://github.com/seek-oss/skuba/pull/184)) +- **template/lambda-sqs-worker:** Qualify `awsRequestId` log field ([#186](https://github.com/seek-oss/skuba/pull/186)) + +## 3.8.0 + +### Minor Changes + +- **template/express-rest-api:** Add new template ([#176](https://github.com/seek-oss/skuba/pull/176)) + +### Patch Changes + +- **deps:** ts-node ^9.0.0 ([#180](https://github.com/seek-oss/skuba/pull/180)) +- **configure, template/\*-npm-package:** Pack JSON files ([#182](https://github.com/seek-oss/skuba/pull/182)) +- **configure:** Retain package comments on first run ([#181](https://github.com/seek-oss/skuba/pull/181)) +- **template:** seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) +- **template/\*-npm-package:** Avoid TSDoc linting errors on init ([#171](https://github.com/seek-oss/skuba/pull/171)) + +## 3.7.7 + +### Patch Changes + +- **template/koa-rest-api:** Use per-Gantry environment concurrency group in dev ([#165](https://github.com/seek-oss/skuba/pull/165)) +- **template:** seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) +- **template/koa-rest-api:** Simplify supertest-koa bootstrap ([#163](https://github.com/seek-oss/skuba/pull/163)) +- **template:** Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) +- **deps:** Limit direct lodash usage to `lodash.mergewith` ([#167](https://github.com/seek-oss/skuba/pull/167)) + +## 3.7.6 + +### Patch Changes + +- **template:** runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) +- **template/koa-rest-api:** Keep AWS SDK connections alive ([#159](https://github.com/seek-oss/skuba/pull/159)) +- **deps:** runtypes ^5.0.0 ([#155](https://github.com/seek-oss/skuba/pull/155)) +- **template:** seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) +- **deps:** typescript 3.9.7 ([#158](https://github.com/seek-oss/skuba/pull/158)) +- **template:** docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) +- **template:** runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) +- **deps:** eslint-config-skuba 1.0.4 ([#157](https://github.com/seek-oss/skuba/pull/157)) + +## 3.7.5 + +### Patch Changes + +- **template/lambda-sqs-worker:** Default VERSION to local ([#148](https://github.com/seek-oss/skuba/pull/148)) +- **template/koa-rest-api:** Add intermediate Dockerfile stages ([#147](https://github.com/seek-oss/skuba/pull/147)) +- **template:** ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) +- **template/koa-rest-api:** Switch to Runtypes ([#152](https://github.com/seek-oss/skuba/pull/152)) + + Yup has overly permissive input coercion (see #151) and weaker type guarantees. + + We already use Runtypes in the Lambda template; other options could be explored in future. + +- **template/lambda-sqs-worker:** Use better Runtypes syntax ([#152](https://github.com/seek-oss/skuba/pull/152)) +- **template:** docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) +- **template:** Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +## 3.7.4 + +### Patch Changes + +- **template/lambda-sqs-worker:** Use connection reuse environment variable ([#130](https://github.com/seek-oss/skuba/pull/130)) +- **template:** Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) +- **deps:** typescript 3.9.6 ([#139](https://github.com/seek-oss/skuba/pull/139)) +- **deps:** eslint-config-skuba 1.0.3 ([#139](https://github.com/seek-oss/skuba/pull/139)) + +## 3.7.3 + +### Patch Changes + +- **test:** Fix `passWithNoTests` warning ([#128](https://github.com/seek-oss/skuba/pull/128)) + +## 3.7.2 + +### Patch Changes + +- **configure:** Avoid stripping of `_` filename prefixes ([#119](https://github.com/seek-oss/skuba/pull/119)) +- **configure:** Remove duplicate `lib` exclusions from `tsconfig.json` ([#124](https://github.com/seek-oss/skuba/pull/124)) +- **test:** Add `Jest.mergePreset` helper function ([#126](https://github.com/seek-oss/skuba/pull/126)) +- **format, lint:** Include tsx files in ESLint linting ([#123](https://github.com/seek-oss/skuba/pull/123)) +- **deps:** eslint ^7.3.1 + eslint-config-skuba 1.0.1 ([#120](https://github.com/seek-oss/skuba/pull/120)) +- **test:** Collect coverage from TSX files ([#125](https://github.com/seek-oss/skuba/pull/125)) +- **configure:** Use simple ESLint extends syntax ([#122](https://github.com/seek-oss/skuba/pull/122)) + +## 3.7.1 + +### Patch Changes + +- **configure:** Format Renovate config ([#111](https://github.com/seek-oss/skuba/pull/111)) +- **configure, init:** Format `package.json` consistently ([#112](https://github.com/seek-oss/skuba/pull/112)) + +## 3.7.0 + +### Minor Changes + +- **configure:** Support migration from `seek-module-toolkit` ([#66](https://github.com/seek-oss/skuba/pull/66)) + + `seek-module-toolkit` users can now install `skuba` and run `skuba configure` to migrate their configuration. + + Care should be taken around the [change in build directories](https://github.com/seek-oss/skuba/blob/master/docs/migration-guides/seek-module-toolkit.md#building). + +- **eslint:** skuba is now usable as a shareable config ([#81](https://github.com/seek-oss/skuba/pull/81)) + + ```javascript + // .eslintrc.js + + module.exports = { + // This can be used in place of require.resolve('skuba/config/eslint') + extends: ['skuba'], + }; + ``` + +- **build, start:** Support experimental Babel toolchain ([#85](https://github.com/seek-oss/skuba/pull/85)) + + You can now build your project with Babel instead of tsc. Experimentally. + + See our [Babel topic](https://github.com/seek-oss/skuba/tree/master/docs/deep-dives/babel.md) for details. + +- **jest:** skuba is now usable as a preset ([#50](https://github.com/seek-oss/skuba/pull/50)) + + ```javascript + // jest.config.js + + const { testPathIgnorePatterns } = require('skuba/config/jest'); + + module.exports = { + // This can be used in place of ...require('skuba/config/jest') + preset: 'skuba', + + // This is still necessary as Jest doesn't deep-merge presets + testPathIgnorePatterns: [...testPathIgnorePatterns, '/test\\.ts'], + }; + ``` + +- **configure:** Replace relocated dependencies ([#54](https://github.com/seek-oss/skuba/pull/54)) + + `skuba configure` now replaces the following dependencies and updates their import paths via naive find-and-replace: + + - `@seek/koala → seek-koala` + - `@seek/node-datadog-custom-metrics → seek-datadog-custom-metrics` + - `@seek/skuba → skuba` + - `@seek/skuba-dive → skuba-dive` + +- **init:** Commit initial template files and configure default remote ([#51](https://github.com/seek-oss/skuba/pull/51)) +- **format, lint:** Enforce TSDoc syntax ([#75](https://github.com/seek-oss/skuba/pull/75)) +- **template/oss-npm-package:** Add new template ([#73](https://github.com/seek-oss/skuba/pull/73)) + + This is intended for [seek-oss](https://github.com/seek-oss) projects. + +### Patch Changes + +- **configure:** Delete `test:build` and `test:jest` scripts ([#95](https://github.com/seek-oss/skuba/pull/95)) +- **configure:** List skuba upgrade upfront ([#68](https://github.com/seek-oss/skuba/pull/68)) +- **configure, init:** Avoid unnecessary file writes during templating ([#48](https://github.com/seek-oss/skuba/pull/48)) +- **template/lambda-sqs-worker:** Drop `hot-shots` dependency ([#57](https://github.com/seek-oss/skuba/pull/57)) +- **configure, init:** Sort dependencies ([#52](https://github.com/seek-oss/skuba/pull/52)) +- **template:** Redact `Authorization` headers in logs ([#59](https://github.com/seek-oss/skuba/pull/59)) +- **template/\*-npm-package:** Make prompt unskippable ([#76](https://github.com/seek-oss/skuba/pull/76)) +- **configure, init:** Exclude `lib-` directories from compilation ([#102](https://github.com/seek-oss/skuba/pull/102)) +- **template/private-npm-package:** Fix ReferenceError on init ([#60](https://github.com/seek-oss/skuba/pull/60)) +- **help:** Show `build-package` correctly ([#55](https://github.com/seek-oss/skuba/pull/55)) +- **configure:** Migrate `collectCoverageFrom` Jest option ([#105](https://github.com/seek-oss/skuba/pull/105)) +- **configure:** Tame newlines in ignore files ([#89](https://github.com/seek-oss/skuba/pull/89)) +- **configure:** List filtered devDependencies upfront ([#67](https://github.com/seek-oss/skuba/pull/67)) +- **configure, init:** `.dockerignore` the `.gantry` folder. This should decrease build times. ([#62](https://github.com/seek-oss/skuba/pull/62)) +- **template/koa-rest-api:** Ensure lint passes on init ([#70](https://github.com/seek-oss/skuba/pull/70)) +- **configure:** Sort more `package.json` props ([#101](https://github.com/seek-oss/skuba/pull/101)) +- **init:** Install matching skuba version ([#83](https://github.com/seek-oss/skuba/pull/83)) +- **init:** Extend validation on initial GitHub fields ([#49](https://github.com/seek-oss/skuba/pull/49)) +- **template/\*-npm-package:** Drop module aliasing from `tsconfig.json` ([#75](https://github.com/seek-oss/skuba/pull/75)) +- **template:** Redact `err.config.sockets` from logs ([#82](https://github.com/seek-oss/skuba/pull/82)) +- **template/koa-rest-api:** Support improved Runtypes error messaging ([#96](https://github.com/seek-oss/skuba/pull/96)) +- **configure:** Handle `skuba-dive` dependency upfront ([#79](https://github.com/seek-oss/skuba/pull/79)) +- **configure:** Migrate select Jest options ([#100](https://github.com/seek-oss/skuba/pull/100)) +- **configure:** Reserve skuba-managed sections in ignore files ([#58](https://github.com/seek-oss/skuba/pull/58)) +- **configure, init:** `.gitignore` archives created by `npm pack` ([#78](https://github.com/seek-oss/skuba/pull/78)) +- **template/private-npm-package:** Include a half-decent README ([#74](https://github.com/seek-oss/skuba/pull/74)) +- **configure, init:** Make mentioned commands actually runnable ([#104](https://github.com/seek-oss/skuba/pull/104)) +- **configure:** Clean up ignore files during migration ([#94](https://github.com/seek-oss/skuba/pull/94)) +- **configure, init:** `.dockerignore` the `.git` folder. This should decrease build times. ([#61](https://github.com/seek-oss/skuba/pull/61)) +- **configure:** Add notice for smt migrations ([#77](https://github.com/seek-oss/skuba/pull/77)) +- **cli:** Suppress dependency deprecation warnings ([#108](https://github.com/seek-oss/skuba/pull/108)) +- **configure:** Delete `.npmignore` ([#93](https://github.com/seek-oss/skuba/pull/93)) +- **template:** Drop duplicate team name prompt ([#72](https://github.com/seek-oss/skuba/pull/72)) +- **template/koa-rest-api:** Use Koala's error handler ([#44](https://github.com/seek-oss/skuba/pull/44)) +- **configure, init:** Reduce unintended stripping of `_` filename prefix ([#106](https://github.com/seek-oss/skuba/pull/106)) + +## 3.6.0 + +### Minor Changes + +- **template/private-npm-package:** Add new template ([#40](https://github.com/seek-oss/skuba/pull/40)) + + The `private-npm-package` template replaces `smt init`. + + This change also defaults TypeScript's `moduleResolution` to `node`. + This shouldn't break any existing consumers as it is the default resolution strategy for CommonJS. + +### Patch Changes + +- **template/koa-rest-api:** Remove unused function ([#35](https://github.com/seek-oss/skuba/pull/35)) +- **init:** Redesign first prompt ([#42](https://github.com/seek-oss/skuba/pull/42)) +- **cli:** Tweak prompt spacing and wording ([#39](https://github.com/seek-oss/skuba/pull/39)) +- **template/koa-rest-api:** Pass through Gantry environment as ENVIRONMENT ([#37](https://github.com/seek-oss/skuba/pull/37)) +- **deps:** Bump bundled and template dependencies ([#43](https://github.com/seek-oss/skuba/pull/43)) + + This includes TypeScript 3.9.5. + +## 3.5.1 + +### Patch Changes + +- **format, lint:** Relax on Jest config files ([#31](https://github.com/seek-oss/skuba/pull/31)) + +## 3.5.0 + +### Minor Changes + +- **format, lint:** ESLint 7 + `typescript-eslint` 3 ([#19](https://github.com/seek-oss/skuba/pull/19)) + + This upgrade introduces stricter rules around `any` and `object` usage for type safety. + + Consider the following alternatives: + + - Use `unknown` for a value whose type is truly unknown. This is a type-safe alternative to `any` that the TypeScript ecosystem is moving towards. + + ```diff + - const data = JSON.parse(str); + + const data = JSON.parse(str) as unknown; + ``` + + - Prove the value has a specific type using a [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards) or runtime validation library. + + ```diff + - const safeData = inputData as any; + + const safeData = RuntimeValidator.check(inputData); + ``` + + - Use `Record` to indicate an object with unknown properties. + + ```diff + - const isObject = (data: unknown): data is object => { ... }; + + const isObject = (data: unknown): data is Record => { ... }; + ``` + + - Disable the specific ESLint rule for the problematic line. + + ```typescript + /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment */ + const takeAnyBody = ctx.request.body; + ``` + +- **build-package:** Add opinionated command to replace `smt build` ([#15](https://github.com/seek-oss/skuba/pull/15)) + + See the [migration documentation](https://github.com/seek-oss/skuba/blob/master/docs/migration-guides/seek-module-toolkit.md) for more information. + +### Patch Changes + +- **init:** Restore `--silent` arg for `yarn add` ([#30](https://github.com/seek-oss/skuba/pull/30)) +- **configure, init:** Tweak ignore file patterns ([#11](https://github.com/seek-oss/skuba/pull/11)) + + Directory names like `/lib-es2015` are ignored based on prefix now, + but certain patterns have been restricted to the root to allow for `/src/lib`. + +- **configure:** Use `latest-version` to check package versions ([#24](https://github.com/seek-oss/skuba/pull/24)) +- **configure, init:** Switch to oss `skuba-dive` package ([#21](https://github.com/seek-oss/skuba/pull/21)) +- **template:** Switch to `seek-datadog-custom-metrics` ([#28](https://github.com/seek-oss/skuba/pull/28)) +- **template/koa-rest-api:** Switch to `seek-koala` ([#28](https://github.com/seek-oss/skuba/pull/28)) +- **configure:** Keep name, readme and version fields in package.json ([#18](https://github.com/seek-oss/skuba/pull/18)) +- **configure:** Drop `--ignore-optional` from `yarn install` ([#25](https://github.com/seek-oss/skuba/pull/25)) +- **start:** Remove support for a custom port logging function ([#16](https://github.com/seek-oss/skuba/pull/16)) +- **init:** Drop `--ignore-optional --silent` from `yarn add` ([#25](https://github.com/seek-oss/skuba/pull/25)) +- **template/koa-rest-api:** Bump Gantry plugin to v1.2.2 ([#8](https://github.com/seek-oss/skuba/pull/8)) +- **deps:** Declare `@types/jest` as a peer dependency ([#22](https://github.com/seek-oss/skuba/pull/22)) +- **format, lint:** Group `'src'` import along with `'src/**'` ([#7](https://github.com/seek-oss/skuba/pull/7)) +- **configure, init:** Exclude files from templating based on .gitignore ([#20](https://github.com/seek-oss/skuba/pull/20)) + +## 3.4.1 + +### Patch Changes + +- **pkg:** Release on `seek-oss` ([#4](https://github.com/seek-oss/skuba/pull/4)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..7ff9651c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,255 @@ +--- +nav_order: 99 +--- + +# Contributing + +--- + +Hi there, thanks for checking out our repo! + +**skuba** is a toolkit for developing TypeScript backend applications and packages at SEEK. +While third-party contributions are certainly welcome, +this project is primarily driven by our internal priorities and technical guidelines. + +SEEKers: this repo is public, +so don't commit or post anything that isn't ready for the entire world to see. + +--- + +## Getting started + +**skuba** is documented through its [README](README.md), +along with some targeted topics under the [docs](docs) directory. +We maintain a [changelog] and [release notes] on GitHub, +and distribute it as an [npm package]. + +### I want to discuss or report something + +[Submit an issue] if you have a question, feature request or bug report. + +If you work at SEEK, start a discussion in [#typescriptification]. + +### I want to contribute a change + +Feel free to [create a pull request] for trivial fixes and improvements. + +For more substantial features, please [submit an issue] first. +This lets us evaluate whether the feature fits the direction of the project and discuss possible approaches. + +If you work at SEEK, start a discussion in [#skuba-development]. + +--- + +## Development + +### Prerequisites + +**skuba** is predominantly tested on macOS and Linux. +If you're on Windows, we recommend the [Windows Subsystem for Linux]. + +First, some JavaScript tooling: + +- Node.js 16+ +- Yarn 1.x + +Next, install npm dependencies: + +```shell +yarn install +``` + +### Git workflow + +We use [GitHub flow](https://guides.github.com/introduction/flow/). + +Create a new branch off of the latest commit on master: + +```shell +git fetch origin +git switch --create your-branch-name origin/master +``` + +Develop, [test](#testing) and commit your changes on this branch. +(Make sure to include the appropriate [changeset](#creating-a-changeset).) + +```shell +git add --all +git commit +``` + +Finally, push your branch to GitHub and [create a pull request]: + +```shell +git push --set-upstream origin your-branch-name +``` + +If you don't have push access, +you may need to [fork the repo] and push there instead: + +```shell +git remote add fork git@github.com:your-username/skuba.git +git push --set-upstream fork your-branch-name +``` + +A maintainer will get to your pull request and review the changes. +If all is well, they will merge your pull request into master. + +### Testing + +You may find it easier to develop alongside unit tests: + +```shell +yarn test --watch +``` + +Format your code once you're happy with it: + +```shell +yarn format +``` + +We run linting and testing in CI, +but consider running these commands locally for a faster feedback loop: + +```shell +yarn lint +yarn test +``` + +Our [validate](https://github.com/seek-oss/skuba/blob/master/.github/workflows/validate.yml) GitHub Actions workflow also initialises each built-in **skuba** template and runs through a set of CLI commands. +This can be reproduced locally, +but keep in mind that the script is fairly slow and you'll have to manually clean up afterwards. + +```shell +# greeter | koa-rest-api | ... +yarn test:template greeter + +# clean up temporary sibling directory +rm -fr ../tmp-greeter +``` + +### Running locally + +If you want to try out the **skuba** CLI on itself, +a `yarn skuba` script is configured: + +```shell +# Prints available commands. +yarn skuba + +# Prints version from local package.json. +yarn skuba version + +# Builds skuba using itself. +yarn skuba build +``` + +If you want to try out the **skuba** CLI on another local repo, +use [yarn link]: + +```shell +# Do this once upfront. +yarn link + +# `yarn link` points to the JavaScript output in `./lib`. +# This means you'll need to rebuild skuba on every code change 😔. +yarn build + +# Link your local skuba binary to another local repo. +cd ../some-other-repo +yarn link skuba + +# Run skuba commands against the other repo. +yarn skuba version + +# Avoid command confusion after you're done. +cd - +yarn unlink +``` + +--- + +## Releases + +### Creating a changeset + +We use [Changesets] to manage package releases. +You'll see a 🦋 bot gliding around pull requests. + +You should write a changeset if you are changing the public **skuba** interface, +which includes: + +- [API](https://github.com/seek-oss/skuba/tree/master/src/api) for Node.js build and test code +- [CLI](https://github.com/seek-oss/skuba/tree/master/src/cli) commands +- [Config](https://github.com/seek-oss/skuba/tree/master/config) presets +- [Template](https://github.com/seek-oss/skuba/tree/master/template) code and documentation +- [npm dependencies](https://github.com/seek-oss/skuba/blob/master/package.json) + +On the other hand, +a changeset is not necessary for: + +- Documentation like the [README](README.md) +- Internal refactoring that preserves the existing interface +- [npm dev dependencies](https://github.com/seek-oss/skuba/blob/master/package.json) + +```shell +yarn changeset +``` + +The Changesets CLI is interactive and follows [semantic versioning]: + +- Patch release `0.0.X`: fixes or tweaks to existing functionality +- Minor release `0.X.0`: new, backwards-compatible functionality +- Major release `X.0.0`: backwards-incompatible modification + +Prefix your changeset title with a `scope:`. +This makes it easy to eyeball which part of **skuba** a change relates to. + +```text +test: Fix command + +template: Add next steps to READMEs + +template/koa-rest-api: Switch to Express + +format, lint: Introduce new ESLint rule +``` + +The Changesets CLI will generate a Markdown file under [.changeset](https://github.com/seek-oss/skuba/tree/master/.changeset), +which you should include in your pull request. +It doesn't need to be part of the same commit as the rest of your changes. +Feel free to manually edit this file to include more details about your change. + +### Publishing a release + +When a pull request with a changeset is merged, +our CI workflow will create a new `Version Packages` PR. +The changesets are used to infer the next semantic version and to update the [changelog]. + +This PR may be left open to collate multiple changes into the next version. +A maintainer will merge it once ready, +and our [release](https://github.com/seek-oss/skuba/blob/master/.github/workflows/release.yml) GitHub Actions workflow will publish the associated GitHub release and npm package version. + +### Publishing a prerelease + +Prereleases can be created on demand via [seek-oss/changesets-snapshot]. + +Run the [Snapshot workflow] in GitHub Actions to publish a new snapshot version to npm. + + + +[#skuba-development]: https://slack.com/app_redirect?channel=C03UM9GBGET +[#typescriptification]: https://slack.com/app_redirect?channel=CDCPCEPV3 +[changelog]: CHANGELOG.md +[changesets]: https://github.com/atlassian/changesets +[create a pull request]: https://github.com/seek-oss/skuba/compare +[fork the repo]: https://github.com/seek-oss/skuba/fork +[npm package]: https://www.npmjs.com/package/skuba +[release notes]: https://github.com/seek-oss/skuba/releases +[seek-oss/changesets-snapshot]: https://github.com/seek-oss/changesets-snapshot +[semantic versioning]: https://semver.org/ +[snapshot workflow]: https://github.com/seek-oss/skuba/actions/workflows/snapshot.yml +[submit an issue]: https://github.com/seek-oss/skuba/issues/new/choose +[windows subsystem for linux]: https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux +[yarn link]: https://classic.yarnpkg.com/lang/en/docs/cli/link/ diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..e66cf6327 --- /dev/null +++ b/_config.yml @@ -0,0 +1,19 @@ +include: + - CHANGELOG.md + - CONTRIBUTING.md +title: skuba + +remote_theme: pmarsceill/just-the-docs + +aux_links: + GitHub: + - https://github.com/seek-oss/skuba + npm: + - https://www.npmjs.com/package/skuba +aux_links_new_tab: true + +gh_edit_link: true +gh_edit_link_text: Edit this page +gh_edit_repository: https://github.com/seek-oss/skuba +gh_edit_branch: master +gh_edit_view_mode: tree diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 000000000..d785be65e --- /dev/null +++ b/docs/about.md @@ -0,0 +1,78 @@ +--- +nav_order: 97 +--- + +# About + +--- + +## Goals + +### Speed up prototyping and project creation + +### Standardise tooling + +**skuba** tracks technology recommendations from [SEEK's Technical Guidelines]. + +### Reduce maintenance overhead + +**skuba** bundles developer tooling into one `package.json#/devDependency`. + +This tooling is managed and upgraded for you. +Upgrades are consolidated into one Renovate PR. + +--- + +## Non-goals + +### Support for vanilla JavaScript + +TypeScript is proposed as the default language of SEEK. + +**skuba** prescribes TypeScript-focused tooling. + +### One stencil to rule them all + +**skuba** may advocate for certain approaches and technologies through its templates, +but this shouldn't be taken as the only way you can write code. + +You can continue to base codebases on your own starters and stencils. + +### One library to rule them all + +**skuba** distributes a minimal runtime component through the **skuba-dive** package. +It has no aspirations of becoming a monolithic Node.js runtime library. + +SEEK's developer community maintains an assortment of targeted packages. + +Here are some highlights: + +| Package | Description | +| :----------------------------- | :----------------------------------------------------- | +| [@seek/logger] | Write application logs in a standardised format | +| [seek-datadog-custom-metrics] | Write Datadog metrics in [Gantry] and Lambda | +| [seek-koala] | Add SEEK-standard observability to Koa servers | +| 🔒 [@seek/db-client] | Connect to databases with credential (rotation) smarts | +| 🔒 [@seek/node-s2sauth-issuer] | Call an [s2sauth]-protected service | +| 🔒 [@seek/typegen] | Generate TypeScript types from a JSON schema | +| 🔒 [@seek/zactive-directory] | Authenticate and authorise [SSOd] users | + +--- + +## Related reading + +- [SEEK's Technical Guidelines] +- SEEK's frontend development toolkit, [sku] + +[@seek/db-client]: https://github.com/SEEK-Jobs/db-client +[@seek/logger]: https://github.com/seek-oss/logger +[@seek/node-s2sauth-issuer]: https://github.com/SEEK-Jobs/node-s2sauth-issuer +[@seek/typegen]: https://github.com/SEEK-Jobs/typegen +[@seek/zactive-directory]: https://github.com/SEEK-Jobs/zactive-directory +[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/ +[s2sauth]: https://github.com/SEEK-Jobs/s2sauth +[seek-datadog-custom-metrics]: https://github.com/seek-oss/datadog-custom-metrics +[seek-koala]: https://github.com/seek-oss/koala +[SEEK's Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/ +[sku]: https://github.com/seek-oss/sku +[SSOd]: https://github.com/SEEK-Jobs/seek-ssod-ingress diff --git a/docs/cli/build.md b/docs/cli/build.md new file mode 100644 index 000000000..24effd0fb --- /dev/null +++ b/docs/cli/build.md @@ -0,0 +1,99 @@ +--- +parent: CLI +nav_order: 6 +--- + +# Build code + +--- + +**skuba** uses [tsc] or [esbuild] to transpile your TypeScript source code to JavaScript output. + +The resulting output can be executed with a regular Node.js runtime, +or in the case of packages, +consumed in other projects without the need for additional transpilation. + +See our [esbuild] topic for further deliberation over our choice of build tool. + +--- + +## skuba build + +Compiles your project. + +```shell +skuba build + +# TSFILE: ... +``` + +By convention, this points to a `tsconfig.build.json` that excludes tests from your production bundle. + +```jsonc +// tsconfig.build.json +{ + "exclude": ["**/__mocks__/**/*", "**/*.test.ts", "src/testing/**/*"], + "extends": "tsconfig.json", + "include": ["src/**/*"] +} +``` + +```jsonc +// tsconfig.json +{ + "compilerOptions": { + "outDir": "lib" + }, + "exclude": ["lib*/**/*"] +} +``` + +Run [`skuba configure`] if you don't already have this file. + +With tsc, you can supply any [compiler option] with the following caveats: + +1. Long-form option names must use a double `--` prefix rather than a single `-` prefix +2. Complex configurations make it difficult to port your project between build tools + +With esbuild, you can supply the following options: + +| Option | Description | +| :---------- | :---------------------------------------- | +| `--debug` | Enable debug console output | +| `--project` | Point to a different `tsconfig.json` file | + +--- + +## skuba build-package + +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`]. + +```shell +skuba build-package + +# commonjs │ TSFILE: ... +# commonjs │ tsc exited with code 0 +# es2015 │ TSFILE: ... +# es2015 │ tsc exited with code 0 +# types │ TSFILE: ... +# types │ tsc exited with code 0 +``` + +`skuba build-package` runs operations concurrently up to your [CPU core count]. +On a resource-constrained Buildkite agent, +you can limit this with the `--serial` flag. +See our [Buildkite guide] for more information. + +| Option | Description | +| :--------- | :----------------------------------------------- | +| `--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 +[cpu core count]: https://nodejs.org/api/os.html#os_os_cpus +[esbuild]: ../deep-dives/esbuild.md +[tsc]: https://www.typescriptlang.org/docs/handbook/compiler-options.html diff --git a/docs/cli/configure.md b/docs/cli/configure.md new file mode 100644 index 000000000..e4fa710ba --- /dev/null +++ b/docs/cli/configure.md @@ -0,0 +1,48 @@ +--- +parent: CLI +nav_order: 2 +--- + +# Update an existing project + +--- + +**skuba** allows for existing projects to be adopted into its tooling and reconfigured on demand. + +This is an area where we still have a lot of work to do; +reach out if you're having difficulties reconfiguring your project. + +--- + +## skuba configure + +Bootstraps an existing project. + +This provides a step-by-step prompt for replacing your config with **skuba**'s. + +```shell +skuba configure + +# ╭─╮ ╭─╮ +# ╭───│ ╰─╭─┬─╮ ╰─╮───╮ +# │_ ─┤ <│ ╵ │ • │ • │ +# ╰───╰─┴─╰───╯───╯── ╰ +# +# 0.0.0 | latest 0.0.0 +# +# Detected project root: /my-repo + +? Project type: … +❯ application + package + +# ... +``` + +You should have a clean working tree before running this command, +so it's easy to `git reset` in case you want to restore your original config. +`skuba configure` will warn if it detects uncommitted changes: + +```shell +You have dirty/untracked files that may be overwritten. +``` diff --git a/docs/cli/help.md b/docs/cli/help.md new file mode 100644 index 000000000..a08a83daa --- /dev/null +++ b/docs/cli/help.md @@ -0,0 +1,31 @@ +--- +parent: CLI +nav_order: 7 +--- + +# Help + +--- + +## skuba help + +Echoes the available **skuba** commands. + +```shell +skuba +skuba help +skuba -h +skuba --help +``` + +--- + +## skuba version + +Echoes the installed version of **skuba**. + +```shell +skuba version +skuba -v +skuba --version +``` diff --git a/docs/cli/index.md b/docs/cli/index.md new file mode 100644 index 000000000..f65070064 --- /dev/null +++ b/docs/cli/index.md @@ -0,0 +1,40 @@ +--- +has_children: true +nav_order: 2 +--- + +# CLI + +--- + +**skuba** includes a set of CLI commands for developing your project, +which replace direct calls to underlying tooling such as [ESLint] and [tsc]. + +In other development environments, +you may see common commands and tasks encapsulated in standalone shell scripts, +or build tools like [Make] and [Gradle]. + +Within the JavaScript ecosystem, +the lowest-friction way of defining reusable scripts is within your [package.json] manifest: + +```json +{ + "scripts": { + "build": "skuba build", + "format": "skuba format" + } +} +``` + +These scripts are executable through your package manager: + +```shell +yarn build +yarn format +``` + +[eslint]: https://eslint.org/ +[gradle]: https://gradle.org/ +[make]: https://www.gnu.org/software/make/ +[package.json]: https://nodejs.dev/learn/the-package-json-guide +[tsc]: https://www.typescriptlang.org/docs/handbook/compiler-options.html diff --git a/docs/cli/init.md b/docs/cli/init.md new file mode 100644 index 000000000..161a27a83 --- /dev/null +++ b/docs/cli/init.md @@ -0,0 +1,218 @@ +--- +parent: CLI +nav_order: 1 +--- + +# Create a new project + +--- + +**skuba** can guide you through an interactive prompt to initialise a new directory and Git repository for your project. +It includes a set of starter [templates] that reflect the typical components of a core SEEK service. + +If you are looking to bootstrap an existing project, +see [`skuba configure`]. + +--- + +## skuba init + +Creates a new local project from a starter [template]. + +`skuba init` does not provision any resources in AWS, Buildkite or GitHub on its own, +and only requires a connection to the public npm registry. +Most of its built-in templates start you off with a [Buildkite pipeline] that should be ready to go once you push your repository to GitHub and configure Buildkite. + +| Option | Description | +| :-------- | :-------------------------- | +| `--debug` | Enable debug console output | + +### Interactive walkthrough + +Let's start by running the command: + +```shell +skuba init +``` + +and answering a few starter questions: + +```shell +? For starters, some project details: +⊙ Owner : SEEK-Jobs/my-team +⊙ Repo : my-repo +⊙ Platform : arm64 +⊙ Default Branch : main + +# ... +``` + +`skuba init` will initialise your CODEOWNERS file and a few others based on the specified owner. +GitHub teams can be found at the following URL: + +> github.com/orgs/**SEEK-Jobs**/teams/**my-team**/repositories + +You're now presented with a selection of templates: + +```shell +? Select a template: + express-rest-api +❯ greeter + koa-rest-api + lambda-sqs-worker + lambda-sqs-worker-cdk + oss-npm-package + private-npm-package + github → +``` + +Use the `↑ ↓` arrow keys, then `⏎` enter your selection. + +The selected template will prompt you to fill out some additional fields. +You can skip these for now to get your bearing: + +```shell +This template uses the following information: + +- Prod Buildkite queue + +? Fill this in now? … + yes +❯ no + +Resume this later with yarn skuba configure. +``` + +`skuba init` will take a while to install some initial dependencies, +after which you'll have a new directory to work with: + +```shell +Initialized empty Git repository in /my-repo/.git/ +Installing dependencies... + +✔ All done! Try running: + +cd my-repo +git push --set-upstream origin master +``` + +You can now proceed to the [next steps](#next-steps). + +### Unattended execution + +`skuba init` is interactive by default. +For unattended execution, pipe in JSON: + +```shell +skuba init << EOF +{ + "destinationDir": "tmp-greeter", + "templateComplete": true, + "templateData": { + "ownerName": "my-org/my-team", + "prodBuildkiteQueueName": "123456789012:cicd", + "platformName": "arm64", + "repoName": "tmp-greeter" + }, + "templateName": "greeter" +} +EOF +``` + +-- + +## Next steps + +Now that you've run `skuba init`, where does that leave you? + +### Git repository + +Let's review the Git repository that has been initialised to see what's in there: + +```shell +git log +# Clone greeter +# Initial commit + +git remote get-url origin +# git@github.com:/.git +``` + +**skuba** has committed its initial template files and configured a remote `origin` for you. +You should create the corresponding repository on GitHub and push to it. +Replace `main` with your default branch name as appropriate: + +```shell +git push --set-upstream origin main +``` + +### Directory structure + +Familiarise yourself with the directory structure that **skuba** has created: + +```shell +├── .buildkite +├── .github +└── src + ├── app.test.ts + ├── app.ts +├── .dockerignore +├── .eslintignore +├── .eslintrc.js +├── .gitignore +├── .nvmrc +├── .prettierignore +├── .prettierrc.js +├── Dockerfile +├── README.md +├── docker-compose.yml +├── jest.config.js +├── jest.setup.ts +├── package.json +├── skuba.template.js +├── tsconfig.build.json +├── tsconfig.json +└── yarn.lock +``` + +A few points to call out: + +- There are configuration files aplenty for the various tools we use in **skuba** and more broadly at SEEK. +- The `.buildkite` directory houses a CI/CD pipeline that should be ready to go once you push your repository to GitHub and configure Buildkite. +- The `src` directory contains our source code, which is later compiled to `lib`. +- `package.json` lists your project dependencies and scripts. + +### CLI commands + +Try out some of the commands documented throughout this [CLI] section. + +[`skuba lint`] may be a good starting point: + +```shell +yarn lint +``` + +### Templating + +If you skipped templating earlier, +[`skuba lint`] will complain that you haven't finished it. + +Once you're ready, run [`skuba configure`]: + +```shell +skuba configure +``` + +You can grep your directory for the values you enter to figure out where they are used, +and you can always change them later. + +### README checklist + +Each built-in template has a `README.md` that contains a checklist of next steps to take your project to production. + +[`skuba configure`]: ./configure.md#skuba-configure +[`skuba lint`]: ./lint.md#skuba-lint +[buildkite pipeline]: https://buildkite.com/docs/pipelines/defining-steps +[cli]: ./index.md +[template]: ../templates +[templates]: ../templates diff --git a/docs/cli/lint.md b/docs/cli/lint.md new file mode 100644 index 000000000..b45cb574f --- /dev/null +++ b/docs/cli/lint.md @@ -0,0 +1,82 @@ +--- +parent: CLI +nav_order: 5 +--- + +# Lint code + +--- + +SEEK's Technical Guidelines [prescribe ESLint] for code analysis and the [eslint-config-seek] preset in particular. +**skuba** uses a combination of [ESLint], [Prettier] and [tsc] to enforce code quality. + +See our [ESLint deep dive] for guidance on resolving linting issues and customising linting rules. + +--- + +## skuba format + +Applies automatic code quality fixes and flags issues that require manual intervention. + +This command should be run locally before pushing code to a remote branch. + +```shell +skuba format + +# ESLint +# Processed X files in 1.23s. +# +# Prettier +# Processed X files in 1.23s. +``` + +| Option | Description | +| :-------- | :-------------------------- | +| `--debug` | Enable debug console output | + +--- + +## skuba lint + +Checks for code quality issues. + +This command should be run in CI to verify that [`skuba format`] was applied and triaged locally. + +```shell +skuba lint + +# ESLint │ Processed 123 files in 1.23s. +# Prettier │ Processed 123 files in 1.23s. +# tsc │ TSFILE: /lib/tsconfig.tsbuildinfo +# tsc │ tsc --noEmit exited with code 0 +``` + +`skuba lint` runs operations concurrently up to your [CPU core count]. +On a resource-constrained Buildkite agent, +you can limit this with the `--serial` flag. + +| Option | Description | +| :--------- | :----------------------------------------------- | +| `--debug` | Enable debug console output (implies `--serial`) | +| `--serial` | Force serial execution of linting operations | + +[GitHub autofixes] are enabled when CI and GitHub environment variables are present. + +### Annotations + +`skuba lint` can automatically emit annotations in CI. + +- [Buildkite annotations] are enabled when Buildkite environment variables and the `buildkite-agent` binary are present. +- [GitHub annotations] are enabled when CI and GitHub environment variables are present. + +[`skuba format`]: #skuba-format +[Buildkite annotations]: ../deep-dives/buildkite.md#buildkite-annotations +[CPU core count]: https://nodejs.org/api/os.html#os_os_cpus +[eslint deep dive]: ../deep-dives/eslint.md +[eslint-config-seek]: https://github.com/seek-oss/eslint-config-seek +[ESLint]: https://eslint.org/ +[GitHub annotations]: ../deep-dives/github.md#github-annotations +[GitHub autofixes]: ../deep-dives/github.md#github-autofixes +[prescribe ESLint]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346041/#TypeScript +[Prettier]: https://prettier.io/ +[tsc]: https://www.typescriptlang.org/docs/handbook/compiler-options.html diff --git a/docs/cli/run.md b/docs/cli/run.md new file mode 100644 index 000000000..9da6dc9e3 --- /dev/null +++ b/docs/cli/run.md @@ -0,0 +1,217 @@ +--- +parent: CLI +nav_order: 3 +--- + +# Run code + +--- + +**skuba** lets you interactively run your TypeScript source code during development. +The following commands are powered by [`ts-node`] and [`ts-node-dev`]. + +These commands are only intended to serve local development and simple scripting scenarios, +as a TypeScript process can present substantial overhead at runtime. +In production, we recommend [`skuba build`]ing your project and executing under a regular Node.js runtime. + +--- + +## skuba node + +Runs a TypeScript source file: + +```shell +skuba node src/some-cli-script.ts + +# ... +``` + +or launches a [`ts-node`] REPL if a file is not provided: + +```shell +skuba node src/some-cli-script.ts + +> +``` + +`skuba node` automatically registers your `tsconfig.json` paths as module aliases for ease of local development. +If you use these aliases in your production code, +your entry point(s) will need to import a runtime module alias resolver like [`skuba-dive/register`] or [`tsconfig-paths`]. +For example, your `src/app.ts` may look like: + +```typescript +// This must be imported directly within the `src` directory. +import 'skuba-dive/register'; + +// You can use the `src` module alias after registration. +import { rootLogger } 'src/framework/logging'; +``` + +--- + +## skuba start + +Starts a live-reloading server for local development. + +```shell +skuba start src/app.ts +``` + +The entry point is chosen from: + +1. Command line argument: `skuba start src/app.ts` +1. Manifest configuration: `package.json#/skuba/entryPoint` +1. Default: `src/app.ts` + +`skuba start` automatically registers your `tsconfig.json` paths as module aliases for ease of local development. +If you use these aliases in your production code, +your entry point(s) will need to import a runtime module alias resolver like [`skuba-dive/register`] or [`tsconfig-paths`]. +For example, your `src/app.ts` may look like: + +```typescript +// This must be imported directly within the `src` directory. +import 'skuba-dive/register'; + +// You can use the `src` module alias after registration. +import { rootLogger } 'src/framework/logging'; +``` + +### Start an executable script + +Your entry point can be a simple module that runs on load: + +```typescript +console.log('Hello world!'); +``` + +### Start a Lambda function handler + +Your entry point can target an exported function: + +```shell +skuba start --port 12345 src/app.ts#handler +``` + +```typescript +export const handler = async (event: unknown, ctx: unknown) => { + // ... + + return; +}; +``` + +This starts up a local HTTP server that you can POST arguments to: + +```shell +curl --data '["event", {"awsRequestId": "123"}]' --include localhost:12345 +``` + +### Start an HTTP server + +Your entry point should export: + +```typescript +interface Export { + // One of these is required. + callback?: () => http.RequestListener; + requestListener?: http.RequestListener; + server?: http.Server; + + // Optional; falls back to an available port. + port?: number; +} +``` + +[Koa] should work with minimal fuss: + +```typescript +const app = new Koa(); + +// You can also use `export =` syntax as required by koa-cluster. +export default Object.assign(app, { port }); +``` + +As should [Fastify]: + +```typescript +const createApp = async () => { + const app = fastify(); + await app.ready(); + return app; +}; +const app = createApp(); + +export default app; +``` + +As should [Express]: + +```typescript +const app = express(); + +export default Object.assign(app, { port }); +``` + +As should a [HTTP Server]: + +```typescript +const app = http.createServer(); + +export default Object.assign(app, { port }); +``` + +### Debugging options + +The `--inspect` and `--inspect-brk` [Node.js options] are supported for debugging sessions. + +Try this out by starting your project with inspector enabled: + +```bash +yarn start:debug +``` + +Next, attach VS Code's debugger to the running process: + +1. Hit `⌘ + ⇧ + P` to bring up the Command Palette. +1. Select `Debug: Attach to Node Process` +1. Select the `node` process that is pointing to `yarn start:debug` + +```shell +Pick the node.js process to attach to + +... + +node /Users/seeker/.nvm/versions/node/vX.Y.Z/bin/yarn start --inspect-brk +process id: 1000 (SIGUSR1) +``` + +If all goes well, the Status Bar will turn orange. +We can progress past the initial breakpoint by pressing the `▶️` button, +then test out a custom breakpoint. + +For example, you could set one in your health check handler if you're working on an API: + +```typescript +// src/api/healthCheck.ts + +🔴 6 ctx.body = ''; +``` + +Then try cURLing your health check endpoint: + +```bash +curl --include localhost:/health +``` + +Execution should pause on the breakpoint until we hit `F5` or the `▶️` button. + +[`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 +[express]: https://expressjs.com/ +[fastify]: https://www.fastify.io/ +[http server]: https://nodejs.org/docs/latest-v18.x/api/http.html#class-httpserver +[koa]: https://koajs.com/ +[node.js options]: https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options diff --git a/docs/cli/test.md b/docs/cli/test.md new file mode 100644 index 000000000..6e05075dc --- /dev/null +++ b/docs/cli/test.md @@ -0,0 +1,42 @@ +--- +parent: CLI +nav_order: 4 +--- + +# Test code + +--- + +**skuba** bundles [Jest] as its testing framework. +SEEK has standardised on Jest across frontend and backend development. + +--- + +## skuba test + +Executes Jest tests. + +Arguments are passed through to the Jest CLI: + +```shell +skuba test --coverage path/to/file.test.ts +``` + +### Annotations + +`skuba test` can automatically emit annotations in CI. + +- [Buildkite annotations] are planned in future. +- [GitHub annotations] are enabled when CI and GitHub environment variables are present. + +GitHub check runs are created with a default title of `skuba/test`. +You can further qualify this by providing a [displayName] in your Jest config; +for example, the display name `integration` will result in the title `skuba/test (integration)`. + +See our [Jest guide] for a more detailed configuration breakdown. + +[buildkite annotations]: ../deep-dives/buildkite.md#buildkite-annotations +[displayname]: https://jestjs.io/docs/configuration#displayname-string-object +[github annotations]: ../deep-dives/github.md#github-annotations +[jest]: https://jestjs.io +[jest guide]: ../deep-dives/jest.md diff --git a/docs/deep-dives/arm64.md b/docs/deep-dives/arm64.md new file mode 100644 index 000000000..75813ef2d --- /dev/null +++ b/docs/deep-dives/arm64.md @@ -0,0 +1,91 @@ +--- +parent: Deep dives +--- + +# ARM64 + +--- + +**skuba** templates are configured to be built and run on ARM64 hardware in [CI/CD]. + +This topic provides some context around this decision, +and discusses how you can [get ready for ARM64](#getting-ready-for-arm64) or [revert to AMD64](#reverting-to-amd64). + +--- + +## Background + +SEEK traditionally ran its compute workloads on AMD64 (x86-64) hardware, +with Intel as the de facto choice across home and server computing. +Our recommendation has since shifted to ARM64 hardware, +with the proliferation of ARM-based alternatives in local and cloud environments providing access to greater cost efficiency. + +On AWS' cloud platform, this means [Graviton-based] instances rather than Intel-based or AMD-based ones. + +--- + +## Getting ready for ARM64 + +If you'd like to build and run your projects on ARM64 hardware, +specify a Buildkite cluster with a Graviton-based instance type. +This is now the default for `vCurrent` strategies: + +```yaml +schemaVersion: vCurrent +clusters: + - # Take care to right-size instances and disk size + instanceType: t4g.large # Optional; g is for Graviton + rootVolumeSize: 8 # Optional +``` + +See [Builds at SEEK] and the [Gantry ARM reference] for more information. + +--- + +## Reverting to AMD64 + +If you are not ready to build and run your projects on ARM64 hardware, +you can downgrade a templated project to be compatible with AMD64 hardware. + +Replace the relevant `--platform` values in your Dockerfile(s), +then ensure that you run your builds on AMD64 hardware: + +```diff +- FROM --platform=arm64 gcr.io/distroless/nodejs20-debian11 AS runtime ++ FROM --platform=${BUILDPLATFORM:-amd64} gcr.io/distroless/nodejs20-debian11 AS runtime + +- FROM --platform=${BUILDPLATFORM:-arm64} gcr.io/distroless/nodejs20-debian11 AS runtime ++ FROM --platform=${BUILDPLATFORM:-amd64} gcr.io/distroless/nodejs20-debian11 AS runtime +``` + +For a [Gantry] service, modify the `cpuArchitecture` property in your `gantry.build.yml` and `gantry.apply.yml` resource files: + +```diff +- cpuArchitecture: arm64 ++ cpuArchitecture: amd64 +``` + +For an [AWS CDK] worker, modify the `architecture` property in your `infra/appStack.ts` file: + +```diff +const worker = new aws_lambda.Function(this, 'worker', { +- architecture: aws_lambda.Architecture.ARM_64, ++ architecture: aws_lambda.Architecture.X86_64, +}); +``` + +For a [Serverless] worker, modify the `provider.architecture` property in your `serverless.yml` file: + +```diff +provider: +- architecture: arm64 ++ architecture: x86_64 +``` + +[aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html +[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/ +[ci/cd]: ./buildkite.md +[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/ +[gantry arm reference]: https://backstage.myseek.xyz/docs/default/component/gantry/v1/reference/using-arm/ +[graviton-based]: https://aws.amazon.com/ec2/graviton/ +[serverless]: https://serverless.com/ diff --git a/docs/deep-dives/babel.md b/docs/deep-dives/babel.md new file mode 100644 index 000000000..41e158832 --- /dev/null +++ b/docs/deep-dives/babel.md @@ -0,0 +1,90 @@ +--- +parent: Deep dives +--- + +# Babel + +--- + +This topic has been reduced to a stub. +Discussion continues in the [esbuild](./esbuild.md) deep dive. + +--- + +## ~~Try it out~~ + +> 🗑 This refers to functionality removed in [**skuba** v3.15.0]. + +1. `babel.config.js` + + ```js + module.exports = { + presets: [require.resolve('skuba/config/babel')], + }; + ``` + +1. `package.json` + + ```jsonc + { + "skuba": { + "babel": true + } + } + ``` + +1. `tsconfig.json` + + ```json + { + "compilerOptions": { + "isolatedModules": true + } + } + ``` + + ([**skuba** v5.0.0] defaults this option to true.) + +1. ...and that's it! + + ```shell + # uses Babel instead of tsc + yarn build + + # uses Nodemon + babel-node instead of ts-node-dev + yarn start + ``` + +--- + +## ~~Current limitations~~ + +> 🗑 This refers to functionality removed in [**skuba** v3.15.0]. + +1. Babel [doesn't support all TypeScript language features]. + +1. Module alias support is hardcoded to `src`. + +1. Build command is hardcoded to input directory `src` and output directory `lib`. + +1. The `babel-node` REPL is fairly primitive. + While it can import TypeScript modules, + it does not support interactive TypeScript nor modern JavaScript syntax: + + ```typescript + import { someExport } from 'src/someModule'; + // Thrown: [...] Modules aren't supported in the REPL + + const { someExport } = require('src/someModule'); + // Thrown: [...] Only `var` variables are supported in the REPL + + var { someExport } = require('src/someModule'); + // undefined + + var v: undefined; + // Thrown: [...] Unexpected token + ``` + +[**skuba** v3.15.0]: https://github.com/seek-oss/skuba/releases/tag/v3.15.0 +[**skuba** v5.0.0]: https://github.com/seek-oss/skuba/releases/tag/v5.0.0 +[doesn't support all typescript language features]: https://babeljs.io/docs/en/babel-plugin-transform-typescript#caveats diff --git a/docs/deep-dives/buildkite.md b/docs/deep-dives/buildkite.md new file mode 100644 index 000000000..6d1963a1f --- /dev/null +++ b/docs/deep-dives/buildkite.md @@ -0,0 +1,116 @@ +--- +parent: Deep dives +--- + +# Buildkite + +--- + +Buildkite is SEEK's [CI/CD] platform of choice. +See [Builds at SEEK] for more information. + +This topic details Buildkite integration features baked into **skuba**, +as well as common issues faced when running your project on a Buildkite agent. + +--- + +## Buildkite annotations + +**skuba** can output issues detected by [`skuba lint`] as [Buildkite annotations]. + +This can be enabled by propagating Buildkite environment variables and the `buildkite-agent` binary. +For example, with the [Docker Buildkite plugin]: + +```yaml +steps: + - command: yarn lint + plugins: + - *aws-sm + - *private-npm + - *docker-ecr-cache + - docker#v5.0.0: + environment: + - BUILDKITE_AGENT_ACCESS_TOKEN + # Enable Buildkite integrations. + propagate-environment: true + volumes: + # Mount agent for Buildkite annotations. + - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent + # Mount cached dependencies. + - /workdir/node_modules +``` + +With Docker Compose, +declare the environment variables and volume mounts in your [Compose file]: + +```yaml +services: + app: + environment: + # Enable Buildkite integrations. + - BUILDKITE + - BUILDKITE_AGENT_ACCESS_TOKEN + - BUILDKITE_JOB_ID + - BUILDKITE_STEP_ID + volumes: + - ./:/workdir + # Mount agent for Buildkite annotations. + - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent + # Mount cached dependencies. + - /workdir/node_modules +``` + +This feature is also planned for [`skuba test`] in future. + +**skuba**'s development API includes a [Buildkite.annotate] function. +You can use this to create your own annotations from other JavaScript code running in your CI workflow. + +--- + +## Buildkite agent exits with status -1 + +**Scenario:** +you're running a **skuba** command like [`skuba build-package`] or [`skuba lint`], +and observe the following error message on a Buildkite step: + +> Exited with status -1 (process killed or agent lost; see the timeline tab for more information) + +Navigating to the Timeline tab reveals this: + +> **Dispatcher Cancelled Job** (+Xm) +> +> | | | +> | :----------------------- | :-------------------------- | +> | **Last Agent Heartbeat** | Yesterday at 0:00:00.000 PM | +> | **Command Exit Status** | `-1 (Agent Lost)` | + +**Explanation:** +This implies that the step(s) exhausted the Buildkite agent's resources. +The agent may be tied up running a particularly compute- or memory-intensive step. + +**Options:** + +1. Pass the `--serial` flag to [`skuba build-package`] and [`skuba lint`] steps. + + This will cause them to run their underlying operations serially, + reducing the chance of resource exhaustion. + + Note that this is automatically inferred for builds on SEEK's central npm publishing pipeline. + +1. Reduce the number of agents that run on each instance. + + At SEEK, this can be configured through BuildAgency. + +1. Increase the instance size. + + At SEEK, this can be configured through BuildAgency. + +[`skuba build-package`]: ../cli/build.md#skuba-build-package +[`skuba lint`]: ../cli/lint.md#skuba-lint +[`skuba test`]: ../cli/test.md#skuba-test +[buildkite.annotate]: ../development-api/buildkite.md#annotate +[buildkite annotations]: https://buildkite.com/docs/agent/v3/cli-annotate +[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/ +[ci/cd]: https://en.wikipedia.org/wiki/CI/CD +[compose file]: https://docs.docker.com/compose/compose-file +[docker buildkite plugin]: https://github.com/buildkite-plugins/docker-buildkite-plugin diff --git a/docs/deep-dives/editors.md b/docs/deep-dives/editors.md new file mode 100644 index 000000000..fe26707b8 --- /dev/null +++ b/docs/deep-dives/editors.md @@ -0,0 +1,38 @@ +--- +parent: Deep dives +--- + +# Editors + +--- + +**skuba** uses regular ESLint and Prettier configurations that should be compatible with most editor integrations. + +--- + +## Visual Studio Code + +1. Install the following community extensions: + + 1. [ESLint (`dbaeumer.vscode-eslint`)](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + 1. [Prettier (`esbenp.prettier-vscode`)](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + +1. ⇧ ⌘ P › Preferences: Open Settings (JSON) + +1. Add the following settings: + + ```json + { + "[typescript]": { + "editor.codeActionsOnSave": { + "source.fixAll.eslint": true + }, + "editor.defaultFormatter": "esbenp.prettier-vscode" + } + } + ``` + +## Webstorm + +1. Go to Settings > Languages & Frameworks > JavaScript > Code Quality Tools > ESLint and tick `Automatic ESLint configuration` and `Run eslint --fix on save`. +2. Go to Settings > Langauges & Frameworks > JavaScript > Prettier and tick `On save`. diff --git a/docs/deep-dives/esbuild.md b/docs/deep-dives/esbuild.md new file mode 100644 index 000000000..9b7d66b87 --- /dev/null +++ b/docs/deep-dives/esbuild.md @@ -0,0 +1,147 @@ +--- +parent: Deep dives +--- + +# esbuild + +--- + +**skuba** currently uses [tsc] as its default build tool. +This topic provides some context around this decision and discusses how esbuild stacks up as an alternative. + +--- + +## Background + +> ["Using the TypeScript compiler is still the preferred way to build TypeScript."](https://devblogs.microsoft.com/typescript/typescript-and-babel-7/) + +The official TypeScript compiler ([tsc]) is the sensible default for building TypeScript projects. +It's a simple tool that _just works_ and has type checking built-in, +but [doesn't expose a plugin system]. +(See [ttypescript] for an unofficial implementation). + +We have explored a few alternatives: + +1. [Babel] was [previously integrated] into **skuba**. + + However, its configuration was complex and largely divergent from a typical TypeScript project, + and the cost-benefit never really worked out for backend projects. + +2. [esbuild] is a bundler and minifier that supports TypeScript transpilation and is now experimentally included in **skuba**. + + It has grown in prominence, + particularly in frontend tooling like [Vite] that may see broader use at SEEK in future. + +3. [swc] is another notable alternative that features in [Next.js] and [Parcel]. + +There are a couple of gotchas when evaluating alternative build tools like esbuild: + +- esbuild strips type information rather than checking it, + so it is often paired with [tsc] in practice. + + [`skuba lint`] already type checks via [tsc], + so a [`skuba build`] without type checking is acceptable. + We still use [tsc] to emit type definitions where requested via `tsconfig.json#/compilerOptions/declaration`. + +- It's another moving part in the toolchain. + + 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`. + + 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, + and could lead to inconsistent runtime behaviour across [`skuba build`], [`skuba node`] and [`skuba start`], + and especially when compared to [tsc]. + +At the same time, esbuild presents potential benefits for **skuba**: + +- Faster and more flexible builds. + + This may allow us to simplify and speed up complex scenarios like [`skuba build-package`]. + +- Bundling and minification. + + This can be useful to improve cold start performance in serverless environments like AWS Lambda. + +- A plugin architecture for transforming code during the build process, along with limited built-in support for `tsconfig.json` paths. + + This allows us to easily configure and resolve module aliases at compile time. + + **skuba**'s existing `tsc`-based build supports a single `src` alias via [skuba-dive]'s [register hook], + which means we impose an unfortunate runtime dependency. + The way that this hook must be imported is a bit magic and makes it difficult to execute arbitrary TypeScript source files, + as the hook must be loaded before any aliased imports. + (This is a big part of why **skuba** has the concept of an explicit entry point for a project.) + + It also enables interoperability with non-JavaScript content. + For example, backend projects could `import query from './query.sql'`. + Such content types are not resolvable by the Node.js runtime, + but a loader can transform the imports at build time. + +--- + +## Try it out + +1. `package.json` + + ```jsonc + { + "skuba": { + "build": "esbuild" + } + } + ``` + +1. `tsconfig.json` + + ```json + { + "compilerOptions": { + "isolatedModules": true + } + } + ``` + + ([**skuba** v5.0.0] defaults this option to true.) + +1. ...and that's it! + + ```shell + # uses esbuild instead of tsc + yarn build + ``` + +--- + +## Current limitations + +This integration is still experimental and only includes the bare minimum to supplant a basic [tsc]-based build. + +1. Some TypeScript language features are not supported. + + See esbuild's [TypeScript caveats] for more information. + +2. esbuild is not wired up to [`skuba build-package`], [`skuba node`] nor [`skuba start`]. + +3. Bundling and minification are not supported. + +[**skuba** v5.0.0]: https://github.com/seek-oss/skuba/releases/tag/v5.0.0 +[`skuba build`]: ../cli/build.md#skuba-build +[`skuba build-package`]: ../cli/build.md#skuba-build-package +[`skuba lint`]: ../cli/lint.md#skuba-lint +[`skuba node`]: ../cli/run.md#skuba-node +[`skuba start`]: ../cli/run.md#skuba-start +[babel]: https://babeljs.io/ +[doesn't expose a plugin system]: https://github.com/Microsoft/TypeScript/issues/14419 +[esbuild]: https://esbuild.github.io/ +[next.js]: https://nextjs.org/ +[parcel]: https://parceljs.org/ +[previously integrated]: ./babel.md +[register hook]: https://github.com/seek-oss/skuba-dive#register +[skuba-dive]: https://github.com/seek-oss/skuba-dive +[swc]: https://swc.rs/ +[tsc]: https://www.typescriptlang.org/docs/handbook/compiler-options.html +[ttypescript]: https://github.com/cevek/ttypescript +[typescript caveats]: https://esbuild.github.io/content-types/#typescript-caveats +[vite]: https://vitejs.dev/ diff --git a/docs/deep-dives/eslint.md b/docs/deep-dives/eslint.md new file mode 100644 index 000000000..e7983eeeb --- /dev/null +++ b/docs/deep-dives/eslint.md @@ -0,0 +1,103 @@ +--- +parent: Deep dives +--- + +# ESLint + +--- + +[ESLint] is _the_ JavaScript linter. +You may be familiar with it from SEEK's frontend development toolkit, +[sku]. + +If you're coming from your own bespoke backend configuration or `@seek/seek-module-toolkit`, +you may have been using [TSLint]. +TSLint has been [out of support since December 2020]. + +Our ESLint configuration introduces stricter rules around unsafe type usage. + +--- + +## Extend configuration + +Please contribute to the [eslint-config-seek] preset if you feel something is missing! +It may worthwhile starting with a discussion in [#typescriptification] to garner feedback. + +If you wish to enforce additional rules within a given codebase or team, +you can [extend] your `.eslintrc.js`: + +```javascript +module.exports = { + extends: ['skuba'], + rules: { + // https://eslint.org/docs/rules/complexity + complexity: ['error', { max: 3 }], + }, +}; +``` + +Let's check that our new rule has taken effect. +Craft some absolute nonsense in a source file: + +```typescript +export const evilFn = () => { + if (NaN) { + if (NaN) { + if (NaN) { + } + } + } +}; +``` + +You should see some red squigglies! + +```text +Arrow function has a complexity of 4. Maximum allowed is 3. eslint(complexity) +``` + +--- + +## Avoid `any` and `object` + +Our ESLint rules flag [unsound type] usage that may cause unexpected runtime behaviour or crashes. + +Consider the following alternatives: + +1. Use `unknown` for a value whose type is truly unknown. This is a type-safe alternative to `any` that the TypeScript ecosystem is moving towards. + + ```diff + - const data = JSON.parse(str); + + const data = JSON.parse(str) as unknown; + ``` + +1. Prove the value has a specific type using a [type guard] or runtime validation library. + + ```diff + - const safeData = inputData as any; + + const safeData = RuntimeValidator.check(inputData); + ``` + +1. Use `Record` to indicate an object with unknown properties. + + ```diff + - const isObject = (data: unknown): data is object => { ... }; + + const isObject = (data: unknown): data is Record => { ... }; + ``` + +1. Disable the specific ESLint rule for the problematic line. + + ```typescript + /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment */ + const takeAnyBody = ctx.request.body; + ``` + +[#typescriptification]: https://slack.com/app_redirect?channel=CDCPCEPV3 +[eslint-config-seek]: https://github.com/seek-oss/eslint-config-seek +[eslint]: https://eslint.org/ +[extend]: https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files +[out of support since december 2020]: https://github.com/palantir/tslint/issues/4534 +[sku]: https://github.com/seek-oss/sku +[tslint]: https://palantir.github.io/tslint/ +[type guard]: https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards +[unsound type]: https://effectivetypescript.com/2021/05/06/unsoundness/#any diff --git a/docs/deep-dives/github.md b/docs/deep-dives/github.md new file mode 100644 index 000000000..c07055f5f --- /dev/null +++ b/docs/deep-dives/github.md @@ -0,0 +1,126 @@ +--- +parent: Deep dives +--- + +# GitHub + +--- + +GitHub is the predominant Git host used at SEEK. + +This topic details GitHub integration features baked into **skuba**. + +--- + +## GitHub annotations + +**skuba** can annotate the first 50 issues detected by [`skuba lint`] and [`skuba test`] via the [GitHub Checks API]. + +This can be enabled by propagating Buildkite environment variables and a GitHub API token. + +For example, with the [Docker Buildkite plugin]: + +```yaml +steps: + - commands: + - yarn lint + - yarn test + env: + # At SEEK, this instructs the build agent to populate the GITHUB_API_TOKEN environment variable for this step. + GET_GITHUB_TOKEN: 'please' + plugins: + - *aws-sm + - *private-npm + - *docker-ecr-cache + - docker#v5.0.0: + # Enable GitHub integrations. + environment: + - GITHUB_API_TOKEN + propagate-environment: true + volumes: + # Mount cached dependencies. + - /workdir/node_modules +``` + +With Docker Compose, +declare the environment variables and volume mounts in your [Compose file]: + +```yaml +services: + app: + environment: + # Enable GitHub integrations. + - BUILDKITE + - BUILDKITE_BRANCH + - BUILDKITE_BUILD_NUMBER + - BUILDKITE_PIPELINE_DEFAULT_BRANCH + - GITHUB_API_TOKEN + volumes: + - ./:/workdir + # Mount cached dependencies. + - /workdir/node_modules +``` + +If you're running in GitHub Actions, +your workflow will automatically have access to the following environment variables to achieve the same effect: + +- `GITHUB_ACTIONS` +- `GITHUB_HEAD_REF` +- `GITHUB_JOB` +- `GITHUB_REF_NAME` +- `GITHUB_REF_PROTECTED` +- `GITHUB_RUN_NUMBER` +- `GITHUB_TOKEN` + +**skuba**'s development API includes a [GitHub.createCheckRun] function. +You can use this to create your own check runs from other JavaScript code running in your CI workflow. + +--- + +## GitHub autofixes + +[`skuba lint`] can generate and push autofixes in CI environments. +This eases adoption of linting rule changes and automatically resolves issues arising from a forgotten [`skuba format`]. + +CI autofixes can be enabled by: + +1. Propagating the environment variables documented above for [GitHub annotations](#github-annotations) +2. Granting repository write access to your CI environment + +In Buildkite, your pipeline needs to be configured with write access. +SEEKers should review our internal "Builds at SEEK" documentation relating to the environment variables documented above for [GitHub annotations](#github-annotations). + +If you're running in GitHub Actions, +you need to supply a personal access token to [actions/checkout]. +Your repository's default `GITHUB_TOKEN` will not suffice as its commits [will not trigger workflows] and will lack (required) status checks. + + + +```yaml +jobs: + validate: + steps: + - name: Check out repo + uses: actions/checkout@v3 + with: + token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + + # Set up Node.js, install dependencies, run tests... + + - name: Lint + run: yarn lint +``` + + + +--- + +[`skuba format`]: ../cli/lint.md#skuba-format +[`skuba lint`]: ../cli/lint.md#skuba-lint +[`skuba test`]: ../cli/test.md#skuba-test +[actions/checkout]: https://github.com/actions/checkout +[compose file]: https://docs.docker.com/compose/compose-file +[docker buildkite plugin]: https://github.com/buildkite-plugins/docker-buildkite-plugin +[github checks api]: https://docs.github.com/en/rest/reference/checks/ +[github.createcheckrun]: ../development-api/github.md#createcheckrun +[will not trigger workflows]: https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow diff --git a/docs/deep-dives/index.md b/docs/deep-dives/index.md new file mode 100644 index 000000000..e40ec7290 --- /dev/null +++ b/docs/deep-dives/index.md @@ -0,0 +1,6 @@ +--- +has_children: true +nav_order: 6 +--- + +# Deep dives diff --git a/docs/deep-dives/jest.md b/docs/deep-dives/jest.md new file mode 100644 index 000000000..8d3796187 --- /dev/null +++ b/docs/deep-dives/jest.md @@ -0,0 +1,78 @@ +--- +parent: Deep dives +--- + +# Jest + +--- + +## Configuring a single test suite + +In the typical case, your project has a single command to run all of its tests: + +```console +skuba test --coverage +``` + +This works well out-of-the-box with the [annotation] features built in to [`skuba test`]. + +--- + +## Configuring multiple test suites + +If you have multiple test suites in your project, +you may have multiple corresponding config files and commands: + +- `skuba test --config jest.config.ts` +- `skuba test --config jest.config.int.ts` + +In this scenario, declare unique [displayName]s so that [`skuba test`] can differentiate between the test suites when annotating your builds. + +For example, if you set the following display names: + +```typescript +// jest.config.ts +import { Jest } from 'skuba'; + +export default Jest.mergePreset({ + displayName: 'unit', + testPathIgnorePatterns: ['\\.int\\.test\\.ts'], +}); +``` + +```typescript +// jest.config.int.ts +import { Jest } from 'skuba'; + +export default Jest.mergePreset({ + displayName: 'integration', + testPathIgnorePatterns: ['\\.unit\\.test\\.ts'], +}); +``` + +**skuba** will generate two GitHub check runs titled `skuba/test (unit)` and `skuba/test (integration)` respectively. + +Alternatively, you can declare multiple [projects] in a single config file: + +```typescript +// jest.config.ts +import { Jest } from 'skuba'; + +export default Jest.mergePreset({ + projects: [ + Jest.mergePreset({ + displayName: 'unit', + testPathIgnorePatterns: ['\\.int\\.test\\.ts'], + }), + Jest.mergePreset({ + displayName: 'integration', + testPathIgnorePatterns: ['\\.unit\\.test\\.ts'], + }), + ], +}); +``` + +[`skuba test`]: ../cli/test.md +[annotation]: ../cli/test.md#annotations +[displayname]: https://jestjs.io/docs/configuration#displayname-string-object +[projects]: https://jestjs.io/docs/configuration#projects-arraystring--projectconfig diff --git a/docs/development-api/buildkite.md b/docs/development-api/buildkite.md new file mode 100644 index 000000000..0062f3788 --- /dev/null +++ b/docs/development-api/buildkite.md @@ -0,0 +1,36 @@ +--- +parent: Development API +--- + +# Buildkite + +--- + +## annotate + +Asynchronously uploads a Buildkite annotation. + +If the following environment variables are not present, +the function will silently return without attempting to annotate: + +- `BUILDKITE` +- `BUILDKITE_AGENT_ACCESS_TOKEN` +- `BUILDKITE_JOB_ID` + +The `buildkite-agent` binary must also be on your `PATH`. + +```typescript +import { Buildkite } from 'skuba'; + +const main = async () => { + const resultMarkdown = await doWork(); + + console.log('Received result:', resultMarkdown); + + await Buildkite.annotate(resultMarkdown); +}; +``` + +See our [Buildkite guide] for more information. + +[buildkite guide]: ../deep-dives/buildkite.md diff --git a/docs/development-api/git.md b/docs/development-api/git.md new file mode 100644 index 000000000..5288121e3 --- /dev/null +++ b/docs/development-api/git.md @@ -0,0 +1,160 @@ +--- +parent: Development API +--- + +# Git + +--- + +## commit + +Writes a commit to the local Git repository. + +```typescript +import { Git } from 'skuba'; + +await Git.commit({ dir, message: 'Test a commit' }); +``` + +--- + +## commitAllChanges + +Stages all changes and writes a commit to the local Git repository. + +Skips the commit and returns `undefined` if there are no changes. + +```typescript +import { Git } from 'skuba'; + +await Git.commitAllChanges({ dir, message: 'Test a commit' }); +``` + +--- + +## currentBranch + +Tries to return a Git branch name from CI environment variables, +falling back to the local Git repository when the current working `dir` is supplied. + +```typescript +import { Git } from 'skuba'; + +const currentBranch = Git.currentBranch({ dir }); +``` + +--- + +## fastForwardBranch + +Fast forwards the specified `ref` on the local Git repository to match the remote branch. + +Currently, only GitHub app tokens are supported as an auth mechanism. + +```typescript +import { Git } from 'skuba'; + +await Git.fastForwardBranch({ + auth: { type: 'gitHubApp' }, + dir, + ref: 'branch-name', +}); +``` + +--- + +## getChangedFiles + +Returns all the files which have been added, modified or deleted in the working directory of the local Git repository since the last commit. + +```typescript +import { Git } from 'skuba'; + +const changedFiles = await Git.getChangedFiles({ dir }); +``` + +--- + +## getHeadCommitId + +Gets the object ID of the head commit. + +This tries to extract the commit ID from common CI environment variables, +and falls back to the local Git repository log. + +```typescript +import { Git } from 'skuba'; + +const headCommitId = await Git.getHeadCommitId({ dir }); +``` + +--- + +## getHeadCommitMessage + +Gets the message of the head commit. + +This tries to extract the message from common CI environment variables, +and falls back to the local Git repository log. + +```typescript +import { Git } from 'skuba'; + +const headCommitMessage = await Git.getHeadCommitMessage({ dir }); +``` + +--- + +## getOwnerAndRepo + +Extracts the owner and repository names from CI environment variables, +falling back to local Git remotes. + +Currently, only GitHub repository URLs are supported: + +```console +git@github.com:seek-oss/skuba.git +https://github.com/seek-oss/skuba.git +``` + +```typescript +import { Git } from 'skuba'; + +const { owner, repo } = await getOwnerAndRepo({ dir }); +``` + +--- + +## push + +Pushes the specified `ref` from the local Git repository to a remote. + +Currently, only GitHub app tokens are supported as an auth mechanism. + +```typescript +import { Git } from 'skuba'; + +await Git.push({ + auth: { type: 'gitHubApp' }, + dir, + ref: 'commit-id', + remoteRef: 'branch-name', +}); +``` + +--- + +## reset + +Resets the specified branch in the local Git repository to a particular commit. + +```typescript +import { Git } from 'skuba'; + +await Git.reset({ + dir, + branch: 'master', + commitId: 'abcd1234', + hard: true, +}); +``` diff --git a/docs/development-api/github.md b/docs/development-api/github.md new file mode 100644 index 000000000..0fb4068b9 --- /dev/null +++ b/docs/development-api/github.md @@ -0,0 +1,193 @@ +--- +parent: Development API +--- + +# GitHub + +--- + +## buildNameFromEnvironment + +Returns the name of the build as seen in GitHub status checks. + +This is driven off of environment variables and falls back to `Build`. + +```typescript +import { GitHub } from 'skuba'; + +const buildName = GitHub.buildNameFromEnvironment(); +``` + +--- + +## createCheckRun + +Asynchronously creates a GitHub [check run] with annotations. + +The first 50 `annotations` are written in full to GitHub. + +A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with the `checks:write` permission must be present on the environment. + +```typescript +import { GitHub } from 'skuba'; + +const main = async () => { + const annotations = await createAnnotations(); + + await GitHub.createCheckRun({ + annotations, + conclusion: 'failure', + name: 'skuba/lint', + summary: '`skuba/lint` found issues that require triage.', + title: 'Build #123 failed', + }); +}; +``` + +See our [GitHub guide] for more information. + +--- + +## enabledFromEnvironment + +Whether GitHub API interactions should be enabled. + +This checks environment variables to see if the code is executing in a CI +environment and has access to a GitHub API token. + +```typescript +import { GitHub } from 'skuba'; + +const enabled = GitHub.enabledFromEnvironment(); + +if (enabled) { + // Do GitHub API things. +} +``` + +--- + +## getPullRequestNumber + +Gets the number of the current pull request. + +This tries to extract the pull request from common CI environment variables, +and falls back to querying the GitHub Repos API for the latest pull request associated with the head commit. +An error is thrown if there are no associated pull requests, or if they are all closed or locked. + +```typescript +import { GitHub } from 'skuba'; + +const pullRequestNumber = await GitHub.getPullRequestNumber(); +``` + +--- + +## putIssueComment + +Asynchronously creates or updates a GitHub issue comment. + +This emulates `put` behaviour by overwriting the first existing comment by the same author on the issue, +enabling use cases like a persistent bot comment at the top of the pull request that reflects the current status of a CI check. + +A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be present on the environment. + +```typescript +import { GitHub } from 'skuba'; + +await GitHub.putIssueComment({ body: '😌 This change looks fine!' }); +``` + +You can specify an internal identifier to scope the `put` to a particular comment, +preventing it from clobbering other comments from the same bot or user. +The identifier is embedded as hidden content in the comment body. + +```typescript +import { GitHub } from 'skuba'; + +await GitHub.putIssueComment({ + body: 'Lint passed!', + internalId: 'lint-a8d9178b-822c-49ac-b456-93653662f685', +}); + +// This posts a distinct comment from the prior call. +await GitHub.putIssueComment({ + body: 'Test passed!', + internalId: 'test-bdc9db38-cc4a-45c3-a7bb-8ebbb3c746a4', +}); +``` + +--- + +## readFileChanges + +Takes a list of `ChangedFiles` from [getChangedFiles], +reads them from the file system, +and maps them to GitHub GraphQL [FileChanges]. + +```typescript +import { GitHub } from 'skuba'; + +const fileChanges = await GitHub.readFileChanges(dir, [ + { path: 'added-path', state: 'added' }, + { path: 'modified-path', state: 'modified' }, + { path: 'delete-path', state: 'deleted' }, +]); +``` + +--- + +## uploadAllFileChanges + +Retrieves all file changes from the local Git repository using [getChangedFiles], +then uploads the changes to a specified GitHub branch using [uploadFileChanges](#uploadfilechanges). + +Returns the commit ID, or `undefined` if there are no changes to commit. + +The file changes will appear as verified commits on GitHub. + +This will not update the local Git repository unless `updateLocal` is specified. + +```typescript +import { GitHub } from 'skuba'; + +const maybeCommitId = await GitHub.uploadAllFileChanges({ + dir: './', + branch: 'some-branch', + messageHeadline: 'some-commit', + messageBody: 'extra-body', + updateLocal: true, // Updates the local Git repository to match the new remote branch state +}); +``` + +--- + +## uploadFileChanges + +Uploads file changes from the local workspace to a specified GitHub branch. + +The file changes will appear as verified commits on GitHub. + +This will not update the local Git repository. + +```typescript +import { GitHub } from 'skuba'; + +const commitId = await GitHub.uploadFileChanges({ + dir: './', + branch: 'some-branch', + fileChanges: { + additions: [{ contents: '', path: 'another-path' }], + deletions: [{ path: 'some-path' }], + }, + messageHeadline: 'some-commit', + messageBody: 'extra-body', +}); +``` + +--- + +[check run]: https://docs.github.com/en/rest/reference/checks#runs +[filechanges]: https://docs.github.com/en/graphql/reference/input-objects#filechanges +[getchangedfiles]: ./git.md#getchangedfiles +[github guide]: ../deep-dives/github.md diff --git a/docs/development-api/index.md b/docs/development-api/index.md new file mode 100644 index 000000000..813a10fdc --- /dev/null +++ b/docs/development-api/index.md @@ -0,0 +1,20 @@ +--- +has_children: true +nav_order: 4 +--- + +# Development API + +--- + +**skuba** should be a `devDependency` that is excluded from your production bundle. + +```json +{ + "devDependencies": { + "skuba": "*" + } +} +``` + +Its Node.js API can be used in build and test code. diff --git a/docs/development-api/jest.md b/docs/development-api/jest.md new file mode 100644 index 000000000..c0e052e82 --- /dev/null +++ b/docs/development-api/jest.md @@ -0,0 +1,27 @@ +--- +parent: Development API +--- + +# Jest + +--- + +## mergePreset + +Merges additional Jest options into the **skuba** preset. + +This concatenates array options like `testPathIgnorePatterns`. + +```js +// jest.config.ts + +import { Jest } from 'skuba'; + +export default Jest.mergePreset({ + coveragePathIgnorePatterns: ['src/testing'], + setupFiles: ['/jest.setup.ts'], + + // This is concatenated to the end of the built-in patterns. + testPathIgnorePatterns: ['/test\\.ts'], +}); +``` diff --git a/docs/development-api/net.md b/docs/development-api/net.md new file mode 100644 index 000000000..5e58e50de --- /dev/null +++ b/docs/development-api/net.md @@ -0,0 +1,36 @@ +--- +parent: Development API +--- + +# Net + +--- + +## waitFor + +Waits for a resource to start listening on a socket address. + +This can be used to wait for a Docker container to start listening on its port. + +```js +// jest.config.int.ts + +import { Jest } from 'skuba'; + +export default Jest.mergePreset({ + globalSetup: '/jest.setup.int.ts', +}); +``` + +```typescript +// jest.setup.int.ts + +import { Net } from 'skuba'; + +export default () => + Net.waitFor({ + host: 'composeService', + port: 5432, + resolveCompose: Boolean(process.env.LOCAL), + }); +``` diff --git a/docs/logo.svg b/docs/logo.svg new file mode 100644 index 000000000..bb5b3a0f2 --- /dev/null +++ b/docs/logo.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/migration-guides/index.md b/docs/migration-guides/index.md new file mode 100644 index 000000000..36f7fecc7 --- /dev/null +++ b/docs/migration-guides/index.md @@ -0,0 +1,6 @@ +--- +has_children: true +nav_order: 7 +--- + +# Migration guides diff --git a/docs/migration-guides/seek-module-toolkit.md b/docs/migration-guides/seek-module-toolkit.md new file mode 100644 index 000000000..764ec2fef --- /dev/null +++ b/docs/migration-guides/seek-module-toolkit.md @@ -0,0 +1,170 @@ +--- +parent: Migration guides +--- + +# @seek/seek-module-toolkit + +--- + +## TL;DR + +```shell +# Ensure you're using @seek/seek-module-toolkit v4 or later. +# Renovate should automatically open a PR for this upgrade. +# If you haven't configured Renovate on your repository, reach out in `#github`. +yarn smt version +# smt version 5.0.0 + +# Upgrade ESLint and Prettier configs first via interactive prompt. +# You can skip to `yarn smt migrate` if you're feeling adventurous. +yarn smt configure + +# Expect to manually fix some linting violations. +# See the Formatting and linting section. +yarn format + +# Migrate to skuba via interactive prompt. +yarn smt migrate + +# Ensure your files are being bundled as expected. +# See the Building section. +yarn build && npm pack +``` + +--- + +## Building + +```shell +smt build → skuba build-package +``` + +`@seek/seek-module-toolkit` compiles your code to: + +- `/lib/commonjs`: CommonJS module-compatible code +- `/lib/es2015`: ES2015 module-compatible code +- `/lib`: TypeScript types + +This presents issues when referencing non-JS assets, +as the compiled code is nested one level deeper than the source code. + +**skuba** compiles your code to: + +- `/lib-commonjs`: CommonJS module-compatible code +- `/lib-es2015`: ES2015 module-compatible code +- `/lib-types`: TypeScript types + +You should remove workarounds such as: + +- Copying non-JS assets into `/lib` so that they are in the parent directory of the referencing code. + + You can include these assets directly in your `package.json#/files` array. + +- Varying the referenced path of non-JS assets based on whether the code is source or compiled (i.e. using `__filename`). + +After running `skuba configure`, +double check that the `package.json` fields look sensible. +Expect something like this: + +```jsonc +{ + "files": [ + "lib*/**/*.d.ts", + "lib*/**/*.js", + "lib*/**/*.js.map", + "lib*/**/*.json" + ], + "main": "./lib-commonjs/index.js", + "module": "./lib-es2015/index.js", + "types": "./lib-types/index.d.ts" +} +``` + +You may test out the packaging changes by either: + +- Pushing your changes to a `beta` Git branch, which releases a beta version on npm. + + In a consuming repo, you can then `yarn install` the beta version to give it a whirl. + +- Locally packaging with `yarn build`, then `npm pack`. + + In a consuming repo, you can then `yarn add ../path/to/package.tgz` the local version to give it a whirl. + +--- + +## Formatting and linting + +```shell +smt format → skuba format + +smt format:check → skuba lint + +smt lint → skuba lint +``` + +`@seek/seek-module-toolkit` <= 4 retained support for [TSLint] configurations. +[TSLint is deprecated and will go out of support by December 2020.](https://github.com/palantir/tslint/issues/4534) + +**skuba** enforces [ESLint] and bundles a more modern set of linting rules. +See our [ESLint guide] for some tips, and reach out in [#typescriptification] if you get stuck on anything. + +[#typescriptification]: https://slack.com/app_redirect?channel=CDCPCEPV3 +[eslint]: https://eslint.org/ +[eslint guide]: ../deep-dives/eslint.md +[tslint]: https://palantir.github.io/tslint/ + +## Committing and releasing + +```shell +smt commit → +smt release → skuba release +``` + +`@seek/seek-module-toolkit` installs a `commit-msg` Git hook that may cause issues on your local machine after migration. +We try to clean this up as part of `smt migrate`, +but if you get the following error on `git commit`: + +```text +Error: Cannot find module '@seek/seek-module-toolkit/lib/commit-msg' +``` + +You can manually fix it up with: + +```text +rm .git/hooks/commit-msg +``` + +**skuba** has not implemented any Git hooks of its own, +but it still uses [semantic-release] under the hood and expects [Conventional Commits]: + +- No release + + ```text + chore(scope): Update documentation + ``` + +- Patch release 0.0.X: fixes or tweaks to existing functionality + + ```text + fix(scope): Squash a bug + ``` + +- Minor release 0.X.0: new, backwards-compatible functionality + + ```text + feat(scope): Add a feature + ``` + +- Major release X.0.0: backwards-incompatible modification + + ```text + fix(scope): Close security holes + + BREAKING CHANGE: We deleted all our code. + ``` + + Note that the `fix` type could be anything; + the `BREAKING CHANGE:` prefix in the commit body is what determines the release as major. + +[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0-beta.2/ +[semantic-release]: https://github.com/semantic-release/semantic-release/ diff --git a/docs/migration-guides/seek-skuba.md b/docs/migration-guides/seek-skuba.md new file mode 100644 index 000000000..a03d91e9b --- /dev/null +++ b/docs/migration-guides/seek-skuba.md @@ -0,0 +1,54 @@ +--- +parent: Migration guides +--- + +# @seek/skuba + +--- + +## 1. Upgrade to `@seek/skuba@3.7` or newer + +Renovate should automatically open a PR for this upgrade. +If you haven't configured Renovate on your repository, +reach out in `#github`. + +To upgrade manually, run: + +```shell +yarn upgrade @seek/skuba --latest +``` + +We've introduced some new linting rules via ESLint 7 + `typescript-eslint` 3. +See our [ESLint guide] for some tips, and reach out in [#typescriptification] if you get stuck on anything. + +[eslint guide]: ../deep-dives/eslint.md +[#typescriptification]: https://slack.com/app_redirect?channel=CDCPCEPV3 + +--- + +## 2. Switch out packages + +If you have a small number of repos, +run the following local commands on each one: + +1. `yarn install` +1. `yarn skuba configure` +1. `yarn format` + +If you have a large number of repos, +you may `yarn global add skuba` upfront, +then run the following commands on each one: + +1. `skuba configure` +1. `yarn format` + +Note: You may need to add `yarn global bin` to your PATH for the commands to run. See the Yarn docs under [Path Setup]. + +[path setup]: https://classic.yarnpkg.com/en/docs/install/#mac-stable + +**skuba** will switch out the following dependencies and rewrite their import paths: + +- `@seek/koala → seek-koala` +- `@seek/node-datadog-custom-metrics → seek-datadog-custom-metrics` +- `@seek/skuba → skuba` +- `@seek/skuba-dive → skuba-dive` diff --git a/docs/runtime-api/index.md b/docs/runtime-api/index.md new file mode 100644 index 000000000..5ba62fd1f --- /dev/null +++ b/docs/runtime-api/index.md @@ -0,0 +1,31 @@ +--- +nav_order: 5 +--- + +# Runtime API + +--- + + + +**skuba-dive** is an optional runtime component for **skuba**. + +**skuba-dive** should be a `dependency` that is included in your production bundle. + +```json +{ + "dependencies": { + "skuba-dive": "*" + }, + "devDependencies": { + "skuba": "*" + } +} +``` + +**skuba-dive** is intentionally limited to boilerplate cross-cutting concerns and runtime augmentations, +as our preference is to foster runtime packages that are specific and standalone rather than bundling a monolithic API. +See our [goals] and [non-goals] to learn more. + +[goals]: ../about.md#goals +[non-goals]: ../about.md#non-goals diff --git a/docs/templates/api.md b/docs/templates/api.md new file mode 100644 index 000000000..6ba4c1628 --- /dev/null +++ b/docs/templates/api.md @@ -0,0 +1,999 @@ +--- +nav_order: 2 +parent: Templates +--- + +# API + +--- + +## express-rest-api + +A REST [resource API] built on the [Express] web framework and deployed with [Gantry]. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/express-rest-api) + + +Added in [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0) + +
+ + Changelog + + {: .text-delta } + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.1.0](https://github.com/seek-oss/skuba/releases/tag/v7.1.0): Switch distroless image from `nodejs:18` to `nodejs18-debian11` ([#1224](https://github.com/seek-oss/skuba/pull/1224)) + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Remove Gantry `ignoreAlarms` override ([#1160](https://github.com/seek-oss/skuba/pull/1160)) + + This issue has been resolved in Gantry v2.2.0; see its [release notes](https://github.com/SEEK-Jobs/gantry/releases/tag/v2.2.0) for more information. + + ```diff + deployment: + - # SEEK-Jobs/gantry#488 + - ignoreAlarms: true + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Replace `'{{.Environment}}'` with a custom `environment` Gantry value. ([#1065](https://github.com/seek-oss/skuba/pull/1065)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): seek-jobs/gantry v2.0.0 ([#935](https://github.com/seek-oss/skuba/pull/935)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix Gantry documentation links ([#931](https://github.com/seek-oss/skuba/pull/931)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): seek-jobs/gantry v1.8.1 ([#887](https://github.com/seek-oss/skuba/pull/887)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Avoid alternative syntax for ENV instructions ([#823](https://github.com/seek-oss/skuba/pull/823)) + + Omitting the `=` symbol in ENV instructions [is discouraged and may be disallowed in future](https://docs.docker.com/engine/reference/builder/#env). + + ```diff + - ENV NODE_ENV production + + ENV NODE_ENV=production + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): seek-jobs/gantry v1.7.0 ([#824](https://github.com/seek-oss/skuba/pull/824)) + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): seek-jobs/gantry v1.6.2 ([#778](https://github.com/seek-oss/skuba/pull/778)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Ignore deployment alarms and ECR scanning ([#773](https://github.com/seek-oss/skuba/pull/773)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): seek-jobs/gantry v1.6.1 ([#759](https://github.com/seek-oss/skuba/pull/759)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Suggest using a secure header middleware ([#579](https://github.com/seek-oss/skuba/pull/579)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): Parameterise AWS region ([#488](https://github.com/seek-oss/skuba/pull/488)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#471](https://github.com/seek-oss/skuba/pull/471)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Reduce app boilerplate ([#478](https://github.com/seek-oss/skuba/pull/478)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Fail Gantry build if ECR scanning reports vulnerabilities ([#373](https://github.com/seek-oss/skuba/pull/373)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Move Gantry region config to plugin options ([#374](https://github.com/seek-oss/skuba/pull/374)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Supply custom autoscaling policy ([#322](https://github.com/seek-oss/skuba/pull/322)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Explicitly register `listen.ts` ([#332](https://github.com/seek-oss/skuba/pull/332)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Clarify health checks and smoke tests ([#332](https://github.com/seek-oss/skuba/pull/332)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use Distroless runtime images ([#316](https://github.com/seek-oss/skuba/pull/316)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Fix server listener and port ([#289](https://github.com/seek-oss/skuba/pull/289)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): seek-jobs/gantry v1.2.6 ([#211](https://github.com/seek-oss/skuba/pull/211)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +
+ +--- + +## koa-rest-api + +A REST [resource API] built on the [Koa] web framework and deployed with [Gantry]. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/koa-rest-api) + + +Added in [3.4.1](https://github.com/seek-oss/skuba/releases/tag/v3.4.1) + +
+ + Changelog + + {: .text-delta } + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Fix `app.test.ts` assertions ([#1282](https://github.com/seek-oss/skuba/pull/1282)) + + Previously, [custom `.expect((res) => {})` assertions](https://github.com/ladjs/supertest#expectfunctionres-) were incorrectly defined to return false rather than throw an error. The template has been updated to avoid this syntax, but the most straightforward diff to demonstrate the fix is as follows: + + ```diff + - await agent.get('/').expect(({ status }) => status !== 404); + + await agent.get('/').expect(({ status }) => expect(status).not.toBe(404)); + ``` + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.1.0](https://github.com/seek-oss/skuba/releases/tag/v7.1.0): Switch distroless image from `nodejs:18` to `nodejs18-debian11` ([#1224](https://github.com/seek-oss/skuba/pull/1224)) + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Remove Gantry `ignoreAlarms` override ([#1160](https://github.com/seek-oss/skuba/pull/1160)) + + This issue has been resolved in Gantry v2.2.0; see its [release notes](https://github.com/SEEK-Jobs/gantry/releases/tag/v2.2.0) for more information. + + ```diff + deployment: + - # SEEK-Jobs/gantry#488 + - ignoreAlarms: true + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Replace `'{{.Environment}}'` with a custom `environment` Gantry value. ([#1065](https://github.com/seek-oss/skuba/pull/1065)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- [4.4.1](https://github.com/seek-oss/skuba/releases/tag/v4.4.1): Drop `uuid` ([#964](https://github.com/seek-oss/skuba/pull/964)) + + V4 UUIDs can be generated using the built-in [`crypto.randomUUID()`](https://nodejs.org/docs/latest-v16.x/api/crypto.html#cryptorandomuuidoptions) function starting from Node.js 14.17. This is analogous to the [`Crypto.randomUUID()`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID) Web API. + + ```diff + - import { v4 as randomUUID } from 'uuid'; + + import { randomUUID } from 'crypto'; + ``` + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): seek-jobs/gantry v2.0.0 ([#935](https://github.com/seek-oss/skuba/pull/935)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix Gantry documentation links ([#931](https://github.com/seek-oss/skuba/pull/931)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): seek-jobs/gantry v1.8.1 ([#887](https://github.com/seek-oss/skuba/pull/887)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Use [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#asynchronous-context-tracking) to track logger context ([#864](https://github.com/seek-oss/skuba/pull/864)) + + We now employ [RequestLogging.createContextStorage](https://github.com/seek-oss/koala/blob/master/src/requestLogging/README.md#context-logging) to thread logging context through the middleware stack of your Koa application. This enables use of a singleton `logger` instance instead of manually propagating Koa context and juggling `rootLogger`s and `contextLogger`s. + + Before: + + ```typescript + import createLogger from '@seek/logger'; + import Koa, { Context } from 'koa'; + import { RequestLogging } from 'seek-koala'; + + const rootLogger = createLogger(); + + const contextLogger = (ctx: Context) => + rootLogger.child(RequestLogging.contextFields(ctx)); + + const app = new Koa().use((ctx) => { + rootLogger.info('Has no context'); + + contextLogger(ctx).info('Has context'); + }); + ``` + + After: + + ```typescript + import createLogger from '@seek/logger'; + import Koa from 'koa'; + import { RequestLogging } from 'seek-koala'; + + const { createContextMiddleware, mixin } = + RequestLogging.createContextStorage(); + + const contextMiddleware = createContextMiddleware(); + + const logger = createLogger({ mixin }); + + const app = new Koa().use(contextMiddleware).use((ctx) => { + logger.info('Has context'); + }); + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Avoid alternative syntax for ENV instructions ([#823](https://github.com/seek-oss/skuba/pull/823)) + + Omitting the `=` symbol in ENV instructions [is discouraged and may be disallowed in future](https://docs.docker.com/engine/reference/builder/#env). + + ```diff + - ENV NODE_ENV production + + ENV NODE_ENV=production + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): seek-jobs/gantry v1.7.0 ([#824](https://github.com/seek-oss/skuba/pull/824)) + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): seek-jobs/gantry v1.6.2 ([#778](https://github.com/seek-oss/skuba/pull/778)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Ignore deployment alarms and ECR scanning ([#773](https://github.com/seek-oss/skuba/pull/773)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): seek-jobs/gantry v1.6.1 ([#759](https://github.com/seek-oss/skuba/pull/759)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Add opt-in OpenTelemetry support ([#706](https://github.com/seek-oss/skuba/pull/706)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Suggest using a secure header middleware ([#579](https://github.com/seek-oss/skuba/pull/579)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): Parameterise AWS region ([#488](https://github.com/seek-oss/skuba/pull/488)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Reduce app boilerplate ([#478](https://github.com/seek-oss/skuba/pull/478)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#471](https://github.com/seek-oss/skuba/pull/471)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Include success message in smoke test body ([#459](https://github.com/seek-oss/skuba/pull/459)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Log returned error responses ([#430](https://github.com/seek-oss/skuba/pull/430)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Fix ineffectual smoke test ([#361](https://github.com/seek-oss/skuba/pull/361)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Fail Gantry build if ECR scanning reports vulnerabilities ([#373](https://github.com/seek-oss/skuba/pull/373)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Remove awkward request body from GET test ([#362](https://github.com/seek-oss/skuba/pull/362)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Move Gantry region config to plugin options ([#374](https://github.com/seek-oss/skuba/pull/374)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): Tidy custom Koa types ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Type context ([#299](https://github.com/seek-oss/skuba/pull/299)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Supply custom autoscaling policy ([#322](https://github.com/seek-oss/skuba/pull/322)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Explicitly register `listen.ts` ([#332](https://github.com/seek-oss/skuba/pull/332)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Limit request logging to errors ([#294](https://github.com/seek-oss/skuba/pull/294)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Clarify health checks and smoke tests ([#332](https://github.com/seek-oss/skuba/pull/332)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use Distroless runtime images ([#316](https://github.com/seek-oss/skuba/pull/316)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-koala ^5.0.0 ([#260](https://github.com/seek-oss/skuba/pull/260)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): hot-shots ^8.0.0 ([#217](https://github.com/seek-oss/skuba/pull/217)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Avoid `export =` syntax ([#90](https://github.com/seek-oss/skuba/pull/90)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): seek-jobs/gantry v1.2.6 ([#211](https://github.com/seek-oss/skuba/pull/211)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Remove `koa-cluster` ([#206](https://github.com/seek-oss/skuba/pull/206)) + + While Fargate environments with <= 1 vCPU appear to expose multiple threads, + clustering does not improve performance and only serves to increase idle memory usage. + + You may add `koa-cluster` yourself if you have a CPU-bound workload running on multiple vCPUs. + Even in such cases, it may be better to run multiple tasks with one vCPU each rather than one task with multiple vCPUs. + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Use per-Gantry environment concurrency group in dev ([#165](https://github.com/seek-oss/skuba/pull/165)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Simplify supertest-koa bootstrap ([#163](https://github.com/seek-oss/skuba/pull/163)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): Keep AWS SDK connections alive ([#159](https://github.com/seek-oss/skuba/pull/159)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add intermediate Dockerfile stages ([#147](https://github.com/seek-oss/skuba/pull/147)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Switch to Runtypes ([#152](https://github.com/seek-oss/skuba/pull/152)) + + Yup has overly permissive input coercion (see #151) and weaker type guarantees. + + We already use Runtypes in the Lambda template; other options could be explored in future. + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `Authorization` headers in logs ([#59](https://github.com/seek-oss/skuba/pull/59)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Ensure lint passes on init ([#70](https://github.com/seek-oss/skuba/pull/70)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `err.config.sockets` from logs ([#82](https://github.com/seek-oss/skuba/pull/82)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Support improved Runtypes error messaging ([#96](https://github.com/seek-oss/skuba/pull/96)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop duplicate team name prompt ([#72](https://github.com/seek-oss/skuba/pull/72)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Use Koala's error handler ([#44](https://github.com/seek-oss/skuba/pull/44)) + +- [3.6.0](https://github.com/seek-oss/skuba/releases/tag/v3.6.0): Remove unused function ([#35](https://github.com/seek-oss/skuba/pull/35)) + +- [3.6.0](https://github.com/seek-oss/skuba/releases/tag/v3.6.0): Pass through Gantry environment as ENVIRONMENT ([#37](https://github.com/seek-oss/skuba/pull/37)) + +- [3.5.0](https://github.com/seek-oss/skuba/releases/tag/v3.5.0): Switch to `seek-datadog-custom-metrics` ([#28](https://github.com/seek-oss/skuba/pull/28)) + +- [3.5.0](https://github.com/seek-oss/skuba/releases/tag/v3.5.0): Switch to `seek-koala` ([#28](https://github.com/seek-oss/skuba/pull/28)) + +- [3.5.0](https://github.com/seek-oss/skuba/releases/tag/v3.5.0): Bump Gantry plugin to v1.2.2 ([#8](https://github.com/seek-oss/skuba/pull/8)) + +
+ +[express]: https://expressjs.com/ +[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/ +[koa]: https://koajs.com/ +[resource api]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346236/#Resource-API diff --git a/docs/templates/barebones.md b/docs/templates/barebones.md new file mode 100644 index 000000000..99886c09a --- /dev/null +++ b/docs/templates/barebones.md @@ -0,0 +1,402 @@ +--- +nav_order: 1 +parent: Templates +--- + +# Barebones + +--- + +## greeter + +A minimal "Hello, World!" project. + +Packs enough Buildkite, Docker and Jest configuration to put you on track for production. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/greeter) + + +Added in [3.4.1](https://github.com/seek-oss/skuba/releases/tag/v3.4.1) + +
+ + Changelog + + {: .text-delta } + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Use `seek-oss/docker-ecr-cache` Buildkite plugin ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Align Dockerfile stages ([#219](https://github.com/seek-oss/skuba/pull/219)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `Authorization` headers in logs ([#59](https://github.com/seek-oss/skuba/pull/59)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `err.config.sockets` from logs ([#82](https://github.com/seek-oss/skuba/pull/82)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop duplicate team name prompt ([#72](https://github.com/seek-oss/skuba/pull/72)) + +- [3.5.0](https://github.com/seek-oss/skuba/releases/tag/v3.5.0): Switch to `seek-datadog-custom-metrics` ([#28](https://github.com/seek-oss/skuba/pull/28)) + +
+ diff --git a/docs/templates/byo.md b/docs/templates/byo.md new file mode 100644 index 000000000..e02efb5e0 --- /dev/null +++ b/docs/templates/byo.md @@ -0,0 +1,20 @@ +--- +nav_order: 99 +parent: Templates +--- + +# BYO + +--- + +**skuba** can initialise a new project from an externally-hosted template. +This allows you to build and maintain template repositories with your own preferred baseline of boilerplate code and configuration. + +--- + +## github + +**skuba** will shallow-clone your template repo from GitHub and apply some of its base configuration on top. +You may need to run [`skuba configure`] after initialisation to fix up inconsistencies. + +[`skuba configure`]: ../cli/configure.md#skuba-configure diff --git a/docs/templates/index.md b/docs/templates/index.md new file mode 100644 index 000000000..1c90d2418 --- /dev/null +++ b/docs/templates/index.md @@ -0,0 +1,23 @@ +--- +has_children: true +nav_order: 3 +--- + +# Templates + +--- + +**skuba** allows you to initialise a new project from a variety of templates. + +[Barebones] templates can be used for proof-of-concepts, scripts, or anything outside of the ordinary. +The other built-in templates represent starting points for the typical kinds of projects you'll build at SEEK, +including backend components such as [APIs] and [workers], +and npm [packages] for sharing code across components. + +You can also define and [bring your own] externally-hosted template. + +[apis]: ./api.md +[barebones]: ./barebones.md +[bring your own]: ./byo.md +[packages]: ./package.md +[workers]: ./worker.md diff --git a/docs/templates/package.md b/docs/templates/package.md new file mode 100644 index 000000000..468f7c5ff --- /dev/null +++ b/docs/templates/package.md @@ -0,0 +1,832 @@ +--- +nav_order: 4 +parent: Templates +--- + +# Package + +--- + +## oss-npm-package + +A public npm package published via [semantic-release] pipeline. + +This is intended for [seek-oss] projects. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/oss-npm-package) + + +Added in [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0) + +
+ + Changelog + + {: .text-delta } + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Set `publishConfig.provenance` to `true` ([#1182](https://github.com/seek-oss/skuba/pull/1182)) + + See for more information. + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [6.0.0](https://github.com/seek-oss/skuba/releases/tag/v6.0.0): Require Node.js 16.11+ ([#1124](https://github.com/seek-oss/skuba/pull/1124)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.4.0](https://github.com/seek-oss/skuba/releases/tag/v4.4.0): Use SSH scheme in repository URL ([#955](https://github.com/seek-oss/skuba/pull/955)) + + We have changed the templated format of the `package.json#repository/url` field. This may resolve `skuba release` errors that reference [Git password authentication is shutting down](https://github.blog/changelog/2021-08-12-git-password-authentication-is-shutting-down/) on the GitHub Blog. + + ```diff + - git+https://github.com/org/repo.git + + git+ssh://git@github.com/org/repo.git + ``` + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Lock down GitHub workflow permissions ([#807](https://github.com/seek-oss/skuba/pull/807)) + + This aligns with [OpenSSF guidance](https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions). + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Pin GitHub action versions ([#805](https://github.com/seek-oss/skuba/pull/805)) + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): Add `yarn commit` script ([#418](https://github.com/seek-oss/skuba/pull/418)) + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Retain comments out of the box ([#184](https://github.com/seek-oss/skuba/pull/184)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): Avoid TSDoc linting errors on init ([#171](https://github.com/seek-oss/skuba/pull/171)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) + +
+ +--- + +## private-npm-package + +A private npm package published via [semantic-release] pipeline. + +This is intended for [SEEK-Jobs] projects under the `@seek` npm org. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/private-npm-package) + + +Added in [3.6.0](https://github.com/seek-oss/skuba/releases/tag/v3.6.0) + +
+ + Changelog + + {: .text-delta } + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [6.0.0](https://github.com/seek-oss/skuba/releases/tag/v6.0.0): Require Node.js 16.11+ ([#1124](https://github.com/seek-oss/skuba/pull/1124)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.4.0](https://github.com/seek-oss/skuba/releases/tag/v4.4.0): Use SSH scheme in repository URL ([#955](https://github.com/seek-oss/skuba/pull/955)) + + We have changed the templated format of the `package.json#repository/url` field. This may resolve `skuba release` errors that reference [Git password authentication is shutting down](https://github.blog/changelog/2021-08-12-git-password-authentication-is-shutting-down/) on the GitHub Blog. + + ```diff + - git+https://github.com/org/repo.git + + git+ssh://git@github.com/org/repo.git + ``` + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Use `npm2` build agent queue ([#843](https://github.com/seek-oss/skuba/pull/843)) + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): Add `yarn commit` script ([#418](https://github.com/seek-oss/skuba/pull/418)) + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Retain comments out of the box ([#184](https://github.com/seek-oss/skuba/pull/184)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): Avoid TSDoc linting errors on init ([#171](https://github.com/seek-oss/skuba/pull/171)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `Authorization` headers in logs ([#59](https://github.com/seek-oss/skuba/pull/59)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Make prompt unskippable ([#76](https://github.com/seek-oss/skuba/pull/76)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Fix ReferenceError on init ([#60](https://github.com/seek-oss/skuba/pull/60)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop module aliasing from `tsconfig.json` ([#75](https://github.com/seek-oss/skuba/pull/75)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `err.config.sockets` from logs ([#82](https://github.com/seek-oss/skuba/pull/82)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Include a half-decent README ([#74](https://github.com/seek-oss/skuba/pull/74)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop duplicate team name prompt ([#72](https://github.com/seek-oss/skuba/pull/72)) + +
+ +[seek-jobs]: https://github.com/orgs/seek-jobs/sso +[seek-oss]: https://github.com/seek-oss +[semantic-release]: https://github.com/semantic-release/semantic-release/ diff --git a/docs/templates/worker.md b/docs/templates/worker.md new file mode 100644 index 000000000..21cee6ca3 --- /dev/null +++ b/docs/templates/worker.md @@ -0,0 +1,1169 @@ +--- +nav_order: 3 +parent: Templates +--- + +# Worker + +--- + +## lambda-sqs-worker + +An asynchronous [worker] built on [AWS Lambda] and deployed with [Serverless]. + +Modelled after the "enricher" pattern where an event is received from a source SNS topic and a corresponding enrichment is published to a destination SNS topic. +For fault tolerance, +a message queue is employed between the source topic and the Lambda function, +and unprocessed events are sent to a dead-letter queue for manual triage. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/lambda-sqs-worker) + + +Added in [3.4.1](https://github.com/seek-oss/skuba/releases/tag/v3.4.1) + +
+ + Changelog + + {: .text-delta } + +- [7.4.0](https://github.com/seek-oss/skuba/releases/tag/v7.4.0): Remove `@aws-sdk/util-utf8-node` library ([#1326](https://github.com/seek-oss/skuba/pull/1326)) + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Change some info logs to debug ([#1178](https://github.com/seek-oss/skuba/pull/1178)) + + The "Function succeeded" log message was changed from `info` to `debug` to reduce the amount of unnecessary logs in production. The message will still be logged in dev environments but at a `debug` level. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Bump aws-sdk-client-mock to 3.0.0 ([#1197](https://github.com/seek-oss/skuba/pull/1197)) + + AWS SDK v3.363.0 shipped with breaking type changes. + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Declare `dd-trace` dependency ([#1051](https://github.com/seek-oss/skuba/pull/1051)) + + This resolves a `Runtime.ImportModuleError` that occurs if this transitive dependency is not installed: + + ```console + Runtime.ImportModuleError + Error: Cannot find module 'dd-trace' + ``` + + Alternatively, you can [configure the Datadog Serverless plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/#configuration-parameters) to bundle these dependencies via [Lambda layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html): + + ```diff + serverless.yml + + custom: + datadog: + - addLayers: false + + addLayers: true + ``` + + ```diff + package.json + + { + "dependencies": { + - "datadog-lambda-js: "x.y.z", + - "dd-trace: "x.y.z" + }, + "devDependencies": { + + "datadog-lambda-js: "x.y.z", + + "dd-trace: "x.y.z" + } + } + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Bump Node.js version to 18 ([#1049](https://github.com/seek-oss/skuba/pull/1049)) + + This release contains some breaking changes to the Lambda runtime such as the removal of AWS SDK V2 in favour of AWS SDK V3. See the [AWS Lambda Node.js 18.x runtime announcement](https://aws.amazon.com/blogs/compute/node-js-18-x-runtime-now-available-in-aws-lambda/) for more information. + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Use single hyphen in `renovate-` branch name prefix ([#1050](https://github.com/seek-oss/skuba/pull/1050)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Adjust Buildkite pipelines for new `renovate--` branch name prefix ([#1022](https://github.com/seek-oss/skuba/pull/1022)) + + See the [pull request](https://github.com/seek-oss/rynovate/pull/76) that aligns our Renovate presets for more information. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.4.1](https://github.com/seek-oss/skuba/releases/tag/v4.4.1): Switch to modern Datadog integration ([#965](https://github.com/seek-oss/skuba/pull/965)) + + Datadog's CloudWatch integration and the associated [`createCloudWatchClient`](https://github.com/seek-oss/datadog-custom-metrics/pull/177) function from [`seek-datadog-custom-metrics`](https://github.com/seek-oss/datadog-custom-metrics) have been deprecated. We recommend [Datadog's Serverless Framework Plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/) along with their first-party [datadog-lambda-js](https://github.com/DataDog/datadog-lambda-js) and [dd-trace](https://github.com/DataDog/dd-trace-js) npm packages. + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Remove tty disable from pipeline ([#918](https://github.com/seek-oss/skuba/pull/918)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Remove unnecessary IAM permission ([#908](https://github.com/seek-oss/skuba/pull/908)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.2](https://github.com/seek-oss/skuba/releases/tag/v4.2.2): Avoid mutation of logger context ([#879](https://github.com/seek-oss/skuba/pull/879)) + + We now perform a shallow copy when retrieving the logger context from `AsyncLocalStorage`. + + ```diff + - mixin: () => loggerContext.getStore() ?? {}, + + mixin: () => ({ ...loggerContext.getStore() }), + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Change deployment method to `direct` ([#868](https://github.com/seek-oss/skuba/pull/868)) + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Use [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#asynchronous-context-tracking) to track logger context ([#871](https://github.com/seek-oss/skuba/pull/871)) + + We now employ this Node.js API to thread logging context through the handler of your Lambda function. This enables use of a singleton `logger` instance instead of manually propagating Lambda context and juggling `rootLogger`s and `contextLogger`s, and is equivalent to #864. + + Before: + + ```typescript + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const rootLogger = createLogger(); + + const contextLogger = ({ awsRequestId }: Context) => + rootLogger.child({ awsRequestId }); + + const handler = async (_event: unknown, ctx: Context) => { + rootLogger.info('Has no context'); + + contextLogger(ctx).info('Has context'); + }; + ``` + + After: + + ```typescript + import { AsyncLocalStorage } from 'async_hooks'; + + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const loggerContext = new AsyncLocalStorage<{ awsRequestId: string }>(); + + const logger = createLogger({ + mixin: () => ({ ...loggerContext.getStore() }), + }); + + const handler = (_event: unknown, { awsRequestId }: Context) => + loggerContext.run({ awsRequestId }, async () => { + logger.info('Has context'); + }); + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Bump Node.js version to 16 ([#862](https://github.com/seek-oss/skuba/pull/862)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Remove `variablesResolutionMode` ([#768](https://github.com/seek-oss/skuba/pull/768)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Starting with v3.0, the "variablesResolutionMode" option is now useless. You can safely remove it from the configuration + More info: https://serverless.com/framework/docs/deprecations/#VARIABLES_RESOLUTION_MODE + ``` + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Add `NODE_ENV=production` to environment variables ([#763](https://github.com/seek-oss/skuba/pull/763)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Move environment variables to `provider.environment` to reduce repetition ([#767](https://github.com/seek-oss/skuba/pull/767)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Disable `tty` on deploy step ([#753](https://github.com/seek-oss/skuba/pull/753)) + + Serverless Framework v3 renders progress spinners on interactive terminals. We recommend disabling [tty](https://github.com/buildkite-plugins/docker-compose-buildkite-plugin#tty-optional-run-only) in CI/CD for cleaner log output. + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): serverless ^3.0.0 ([#748](https://github.com/seek-oss/skuba/pull/748)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Replace `custom.env` configuration with `params` ([#752](https://github.com/seek-oss/skuba/pull/752)) + + You can now define environment specific variables using the new Serverless parameters feature. See for more details. + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Remove `provider.lambdaHashingVersion` ([#751](https://github.com/seek-oss/skuba/pull/751)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Setting "20201221" for "provider.lambdaHashingVersion" is no longer effective as new hashing algorithm is now used by default. You can safely remove this property from your configuration. + ``` + +- [3.17.2](https://github.com/seek-oss/skuba/releases/tag/v3.17.2): Remove qualifier from smoke test invocation ([#743](https://github.com/seek-oss/skuba/pull/743)) + + Previously, this template's smoke test hook specified a `$LATEST` qualifier in its `Lambda.Invoke` API call. AWS authorised the call based on the unqualified Lambda ARN in our `serverless.yml` IAM policy, but will stop doing so after April 2022. + + To avoid deployment failures, remove the qualifier in `src/hooks.ts`. An unqualified call is equivalent to targeting `$LATEST`. + + ```diff + - Qualifier: '$LATEST', + + Qualifier: undefined, + ``` + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Switch to ARM64 architecture ([#640](https://github.com/seek-oss/skuba/pull/640)) + + These are a bit cheaper and a bit faster than x86 Lambdas: + + + The underlying Lambda architecture should be invisible to typical TypeScript Lambdas. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Remove `pino.Logger` indirection ([#624](https://github.com/seek-oss/skuba/pull/624)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Convert Serverless `isProduction` config value to boolean ([#602](https://github.com/seek-oss/skuba/pull/602)) + + This avoids potentially surprising behaviour if you try to make use of this config value in a context that tests for truthiness. The boolean is still correctly applied as a string `seek:env:production` tag value. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Opt in to [new Serverless variables resolver](https://www.serverless.com/framework/docs/deprecations/#NEW_VARIABLES_RESOLVER) ([#601](https://github.com/seek-oss/skuba/pull/601)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Fail fast on invalid Serverless config ([#605](https://github.com/seek-oss/skuba/pull/605)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Prime dev ECR cache in Buildkite pipeline ([#503](https://github.com/seek-oss/skuba/pull/503)) + + This should result in faster "Deploy Dev" times as the ECR cache will already be warm. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Set `memorySize` for smoke test hook to 128 MiB ([#457](https://github.com/seek-oss/skuba/pull/457)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Upgrade to Node 14 ([#347](https://github.com/seek-oss/skuba/pull/347)) + + Node.js 14 is [now supported on AWS Lambda](https://aws.amazon.com/about-aws/whats-new/2021/02/aws-lambda-now-supports-node-js-14/). This lets us upgrade the Node.js requirement for skuba's templates. + + This should only impact newly created projects. You can use the template changes in this PR as an example of how to upgrade an existing project. A future version of skuba may include a fixup command to automatically upgrade your project to the most recent LTS release. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Use new `serverless.yml#/provider/iam` grouping ([#357](https://github.com/seek-oss/skuba/pull/357)) + + The `provider.iamRoleStatements` property [will be removed in Serverless v3](https://github.com/serverless/serverless/blob/v2.25.1/docs/deprecations.md#grouping-iam-settings-under-provideriam). + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): serverless-plugin-canary-deployments ^0.5.0 ([#394](https://github.com/seek-oss/skuba/pull/394)) + + The plugin now patches in CodeDeploy permissions to your `iamRoleStatements`, so you can clean your `serverless.yml`: + + ```diff + - - Action: codedeploy:PutLifecycleEventHookExecutionStatus + - Effect: Allow + - Resource: !Sub arn:aws:codedeploy:${AWS::Region}:${AWS::AccountId}:deploymentgroup:*/${WorkerLambdaFunctionDeploymentGroup} + ``` + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes-filter ^0.6.0 ([#408](https://github.com/seek-oss/skuba/pull/408)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Drop region parameterisation ([#363](https://github.com/seek-oss/skuba/pull/363)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): runtypes ^6.0.0 ([#404](https://github.com/seek-oss/skuba/pull/404)) + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Remove custom Serverless variable syntax ([#350](https://github.com/seek-oss/skuba/pull/350)) + + `serverless@2.3.0` bundled native support for CloudFormation pseudo parameters. This even works with arbitrary logical IDs like `!Sub ${WorkerLambdaFunctionDeploymentGroup}`. + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Use new `serverless.yml#/package/patterns` property ([#415](https://github.com/seek-oss/skuba/pull/415)) + + The `package.exclude` and `package.include` properties [will be removed in Serverless v3](https://github.com/serverless/serverless/blob/v2.32.0/docs/deprecations.md#new-way-to-define-packaging-patterns). + +- [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0): Add GitHub repository settings and Renovate to init checklist ([#388](https://github.com/seek-oss/skuba/pull/388)) + +- [3.12.1](https://github.com/seek-oss/skuba/releases/tag/v3.12.1): seek-jobs/gantry v1.2.11 ([#336](https://github.com/seek-oss/skuba/pull/336)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Simplify Buildkite pipeline ([#314](https://github.com/seek-oss/skuba/pull/314)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Use `jest.config.ts` ([#303](https://github.com/seek-oss/skuba/pull/303)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Add smoke test ([#328](https://github.com/seek-oss/skuba/pull/328)) + + This brings back versioned functions along with `serverless-prune-plugin` to control Lambda storage consumption. By default we configure `serverless-plugin-canary-deployments` for an instantaneous switch once the smoke test has passed, but this can be customised as necessary. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Enable retry of successful deployment steps ([#311](https://github.com/seek-oss/skuba/pull/311)) + + This should be used with caution, but may be necessary if you need to rapidly roll back a broken deployment. + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Add `start` script ([#301](https://github.com/seek-oss/skuba/pull/301)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Require deployment bucket ([#330](https://github.com/seek-oss/skuba/pull/330)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Bump caret ranges ([#331](https://github.com/seek-oss/skuba/pull/331)) + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Lock Serverless `lambdaHashingVersion` ([#329](https://github.com/seek-oss/skuba/pull/329)) + + This gets rid of the following warning when deploying: + + ```text + Deprecation warning: Starting with next major version, default value of provider.lambdaHashingVersion will be equal to "20201221" + More Info: https://www.serverless.com/framework/docs/deprecations/#LAMBDA_HASHING_VERSION_V2 + ``` + +- [3.12.0](https://github.com/seek-oss/skuba/releases/tag/v3.12.0): Uplift READMEs ([#334](https://github.com/seek-oss/skuba/pull/334)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Check coverage on default `test` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Include `test:watch` script ([#290](https://github.com/seek-oss/skuba/pull/290)) + +- [3.11.0](https://github.com/seek-oss/skuba/releases/tag/v3.11.0): Lock `.nvmrc`s to Node.js 12 ([#281](https://github.com/seek-oss/skuba/pull/281)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Add `.me` files ([#248](https://github.com/seek-oss/skuba/pull/248)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Remove redundant `ecr` plugin ([#259](https://github.com/seek-oss/skuba/pull/259)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-jobs/gantry v1.2.9 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): supertest ^6.0.0 ([#243](https://github.com/seek-oss/skuba/pull/243)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): runtypes-filter ^0.4.0 ([#257](https://github.com/seek-oss/skuba/pull/257)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): @koa/router ^10.0.0 ([#249](https://github.com/seek-oss/skuba/pull/249)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Mount working directory in Docker Compose ([#247](https://github.com/seek-oss/skuba/pull/247)) + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): Default to unversioned Lambdas ([#245](https://github.com/seek-oss/skuba/pull/245)) + + Our baseline template does not do canary deployments, and this makes it less likely to hit code storage limits down the road. + +- [3.10.2](https://github.com/seek-oss/skuba/releases/tag/v3.10.2): seek-datadog-custom-metrics ^4.0.0 ([#261](https://github.com/seek-oss/skuba/pull/261)) + +- [3.10.1](https://github.com/seek-oss/skuba/releases/tag/v3.10.1): seek-jobs/gantry v1.2.8 ([#238](https://github.com/seek-oss/skuba/pull/238)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Remove region from subscription example snippet ([#223](https://github.com/seek-oss/skuba/pull/223)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): supertest ^5.0.0 ([#220](https://github.com/seek-oss/skuba/pull/220)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Recommend `@seek/logger` ([#225](https://github.com/seek-oss/skuba/pull/225)) + + This provides logging structure, trimming and redaction over plain Pino. + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): docker-compose v3.7.0 ([#224](https://github.com/seek-oss/skuba/pull/224)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Unset initial skuba version ([#216](https://github.com/seek-oss/skuba/pull/216)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Skip pre-build in Docker Compose service ([#222](https://github.com/seek-oss/skuba/pull/222)) + +- [3.10.0](https://github.com/seek-oss/skuba/releases/tag/v3.10.0): Add `start:debug` scripts ([#230](https://github.com/seek-oss/skuba/pull/230)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): docker-compose v3.6.0 ([#210](https://github.com/seek-oss/skuba/pull/210)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): serverless ^2.0.0 ([#203](https://github.com/seek-oss/skuba/pull/203)) + +- [3.9.2](https://github.com/seek-oss/skuba/releases/tag/v3.9.2): Bump dep ranges ([#212](https://github.com/seek-oss/skuba/pull/212)) + +- [3.9.1](https://github.com/seek-oss/skuba/releases/tag/v3.9.1): Include `aws-sdk` in bundle ([#198](https://github.com/seek-oss/skuba/pull/198)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Use unknown catch clause variables ([#189](https://github.com/seek-oss/skuba/pull/189)) + +- [3.9.0](https://github.com/seek-oss/skuba/releases/tag/v3.9.0): Qualify `awsRequestId` log field ([#186](https://github.com/seek-oss/skuba/pull/186)) + +- [3.8.0](https://github.com/seek-oss/skuba/releases/tag/v3.8.0): seek-jobs/gantry v1.2.5 ([#174](https://github.com/seek-oss/skuba/pull/174)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): seek-jobs/gantry v1.2.4 ([#170](https://github.com/seek-oss/skuba/pull/170)) + +- [3.7.7](https://github.com/seek-oss/skuba/releases/tag/v3.7.7): Remove explicitly set NPM_READ_TOKEN from Dockerfile commands ([#168](https://github.com/seek-oss/skuba/pull/168)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes-filter ^0.3.0 ([#160](https://github.com/seek-oss/skuba/pull/160)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): seek-jobs/gantry v1.2.3 ([#161](https://github.com/seek-oss/skuba/pull/161)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): docker-compose v3.5.0 ([#153](https://github.com/seek-oss/skuba/pull/153)) + +- [3.7.6](https://github.com/seek-oss/skuba/releases/tag/v3.7.6): runtypes ^5.0.0 ([#156](https://github.com/seek-oss/skuba/pull/156)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Default VERSION to local ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): ecr v2.1.1 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Use better Runtypes syntax ([#152](https://github.com/seek-oss/skuba/pull/152)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): docker-compose v3.4.0 ([#144](https://github.com/seek-oss/skuba/pull/144)) + +- [3.7.5](https://github.com/seek-oss/skuba/releases/tag/v3.7.5): Add basic deployment documentation ([#148](https://github.com/seek-oss/skuba/pull/148)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Use connection reuse environment variable ([#130](https://github.com/seek-oss/skuba/pull/130)) + +- [3.7.4](https://github.com/seek-oss/skuba/releases/tag/v3.7.4): Redact `err.config.agent` path from logs ([#140](https://github.com/seek-oss/skuba/pull/140)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop `hot-shots` dependency ([#57](https://github.com/seek-oss/skuba/pull/57)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `Authorization` headers in logs ([#59](https://github.com/seek-oss/skuba/pull/59)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Redact `err.config.sockets` from logs ([#82](https://github.com/seek-oss/skuba/pull/82)) + +- [3.7.0](https://github.com/seek-oss/skuba/releases/tag/v3.7.0): Drop duplicate team name prompt ([#72](https://github.com/seek-oss/skuba/pull/72)) + +- [3.5.0](https://github.com/seek-oss/skuba/releases/tag/v3.5.0): Switch to `seek-datadog-custom-metrics` ([#28](https://github.com/seek-oss/skuba/pull/28)) + +
+ +--- + +## lambda-sqs-worker-cdk + +An asynchronous [worker] built on [AWS Lambda] and deployed with [AWS CDK]. + +```text +SNS -> SQS (with a dead-letter queue) -> Lambda +``` + +Comes with configuration validation and infrastructure snapshot testing. + +[View on GitHub](https://github.com/seek-oss/skuba/tree/master/template/lambda-sqs-worker-cdk) + + +Added in [3.13.0](https://github.com/seek-oss/skuba/releases/tag/v3.13.0) + +
+ + Changelog + + {: .text-delta } + +- [7.4.0](https://github.com/seek-oss/skuba/releases/tag/v7.4.0): Remove `@aws-sdk/util-utf8-node` library ([#1326](https://github.com/seek-oss/skuba/pull/1326)) + +- [7.4.0](https://github.com/seek-oss/skuba/releases/tag/v7.4.0): Introduce bundling with esbuild, `--hotswap` and `--watch` ([#1321](https://github.com/seek-oss/skuba/pull/1321)) + + This template now uses the `aws_lambda_nodejs.NodejsFunction` construct which uses esbuild to bundle the Lambda function. This [reduces cold start time](https://aws.amazon.com/blogs/developer/reduce-lambda-cold-start-times-migrate-to-aws-sdk-for-javascript-v3/) and time to build on CI. + + The `--hotswap` and `--watch` options allow you to rapidly deploy your code changes to AWS, enhancing the developer feedback loop. This change introduces `deploy:hotswap` and `deploy:watch` scripts to the `package.json` manifest and a `Deploy Dev (Hotswap)` step to the Buildkite pipeline. Read more about watch and hotswap [on the AWS Developer Tools Blog](https://aws.amazon.com/blogs/developer/increasing-development-speed-with-cdk-watch/). + +- [7.3.1](https://github.com/seek-oss/skuba/releases/tag/v7.3.1): Update to Node 20 ([#1317](https://github.com/seek-oss/skuba/pull/1317)) + + Consider upgrading the Node.js version for your project across: + + - `.nvmrc` + - `package.json#/engines/node` + - `serverless.yml` + - `@types/node` package version + - CI/CD configuration (`.buildkite/pipeline.yml`, `Dockerfile`, etc.) + + If you are updating your AWS Lambda runtime to `nodejs20.x`, consider reading the [release announcement](https://aws.amazon.com/blogs/compute/node-js-20-x-runtime-now-available-in-aws-lambda/) as there are some breaking changes with this upgrade. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): seek-oss/docker-ecr-cache 2.1 ([#1266](https://github.com/seek-oss/skuba/pull/1266)) + + This update brings a [new `skip-pull-from-cache` option](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin#skipping-image-pull-from-cache) which is useful on `Warm`/`Build Cache` steps. + + At SEEK, our build agents no longer persist their Docker build cache from previous steps. This option allows a preparatory step to proceed on a cache hit without pulling the image from ECR, which can save on average ~1 minute per build for a 2GB Docker image. + +- [7.3.0](https://github.com/seek-oss/skuba/releases/tag/v7.3.0): Mount npm build secret to a separate directory ([#1278](https://github.com/seek-oss/skuba/pull/1278)) + + Our templated Buildkite pipelines currently retrieve a temporary `.npmrc`. This file contains an npm read token that allows us to fetch private `@seek`-scoped packages. + + New projects now write this file to `/tmp/` on the Buildkite agent and mount it as a secret to `/root/` in Docker. This separation allows you to commit a non-sensitive `.npmrc` to your GitHub repository while avoiding accidental exposure of the npm read token. This is especially important if you are migrating a project to [pnpm](https://pnpm.io/), which houses some of its configuration options in `.npmrc`. + + Existing projects are generally advised to wait until we've paved a cleaner migration path for pnpm. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Require Node.js 18.12+ ([#1206](https://github.com/seek-oss/skuba/pull/1206)) + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Change some info logs to debug ([#1178](https://github.com/seek-oss/skuba/pull/1178)) + + The "Function succeeded" log message was changed from `info` to `debug` to reduce the amount of unnecessary logs in production. The message will still be logged in dev environments but at a `debug` level. + +- [7.0.0](https://github.com/seek-oss/skuba/releases/tag/v7.0.0): Bump aws-sdk-client-mock to 3.0.0 ([#1197](https://github.com/seek-oss/skuba/pull/1197)) + + AWS SDK v3.363.0 shipped with breaking type changes. + +- [6.2.0](https://github.com/seek-oss/skuba/releases/tag/v6.2.0): Include manifest files in CODEOWNERS ([#1162](https://github.com/seek-oss/skuba/pull/1162)) + + Our templates previously excluded `package.json` and `yarn.lock` from CODEOWNERS. This was intended to support advanced workflows such as auto-merging PRs and augmenting GitHub push notifications with custom tooling. However, we are reverting this configuration as it is more common for SEEKers to prefer a simpler CODEOWNERS-based workflow. + + This will not affect existing projects. If you create a new project and wish to restore the previous behaviour, you can manually extend `.github/CODEOWNERS`: + + ```diff + * @<%- ownerName %> + + + # Configured by Renovate + + package.json + + yarn.lock + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Declare `dd-trace` dependency ([#1051](https://github.com/seek-oss/skuba/pull/1051)) + + This resolves a `Runtime.ImportModuleError` that occurs if this transitive dependency is not installed: + + ```console + Runtime.ImportModuleError + Error: Cannot find module 'dd-trace' + ``` + + Alternatively, you can [configure the Datadog Serverless plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/#configuration-parameters) to bundle these dependencies via [Lambda layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html): + + ```diff + serverless.yml + + custom: + datadog: + - addLayers: false + + addLayers: true + ``` + + ```diff + package.json + + { + "dependencies": { + - "datadog-lambda-js: "x.y.z", + - "dd-trace: "x.y.z" + }, + "devDependencies": { + + "datadog-lambda-js: "x.y.z", + + "dd-trace: "x.y.z" + } + } + ``` + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Bump Node.js version to 18 ([#1049](https://github.com/seek-oss/skuba/pull/1049)) + + This release contains some breaking changes to the Lambda runtime such as the removal of AWS SDK V2 in favour of AWS SDK V3. See the [AWS Lambda Node.js 18.x runtime announcement](https://aws.amazon.com/blogs/compute/node-js-18-x-runtime-now-available-in-aws-lambda/) for more information. + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Prompt for target platform (`amd64` or `arm64`) ([#1041](https://github.com/seek-oss/skuba/pull/1041)) + +- [5.1.0](https://github.com/seek-oss/skuba/releases/tag/v5.1.0): Use single hyphen in `renovate-` branch name prefix ([#1050](https://github.com/seek-oss/skuba/pull/1050)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Bump greeter and API templates to Node.js 18 ([#1011](https://github.com/seek-oss/skuba/pull/1011)) + + Node.js 18 is now in active LTS. The Lambda templates are stuck on Node.js 16 until the new AWS Lambda runtime is released. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Replace Runtypes with Zod as default schema validator ([#984](https://github.com/seek-oss/skuba/pull/984)) + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Adjust Buildkite pipelines for new `renovate--` branch name prefix ([#1022](https://github.com/seek-oss/skuba/pull/1022)) + + See the [pull request](https://github.com/seek-oss/rynovate/pull/76) that aligns our Renovate presets for more information. + +- [5.0.0](https://github.com/seek-oss/skuba/releases/tag/v5.0.0): Support AMD64 Docker builds via `BUILDPLATFORM` ([#1021](https://github.com/seek-oss/skuba/pull/1021)) + + See the [Docker documentation](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images) for more information. Note that this does not allow you to build on AMD64 hardware then deploy to ARM64 hardware and vice versa. It is provided for convenience if you need to revert to an AMD64 workflow and/or build and run an image on local AMD64 hardware. + +- [4.4.1](https://github.com/seek-oss/skuba/releases/tag/v4.4.1): Switch to modern Datadog integration ([#965](https://github.com/seek-oss/skuba/pull/965)) + + Datadog's CloudWatch integration and the associated [`createCloudWatchClient`](https://github.com/seek-oss/datadog-custom-metrics/pull/177) function from [`seek-datadog-custom-metrics`](https://github.com/seek-oss/datadog-custom-metrics) have been deprecated. We recommend [Datadog's Serverless Framework Plugin](https://docs.datadoghq.com/serverless/libraries_integrations/plugin/) along with their first-party [datadog-lambda-js](https://github.com/DataDog/datadog-lambda-js) and [dd-trace](https://github.com/DataDog/dd-trace-js) npm packages. + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Remove tty disable from pipeline ([#918](https://github.com/seek-oss/skuba/pull/918)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Remove unnecessary IAM permission ([#908](https://github.com/seek-oss/skuba/pull/908)) + +- [4.3.1](https://github.com/seek-oss/skuba/releases/tag/v4.3.1): Fix README link to ARM64 guide ([#913](https://github.com/seek-oss/skuba/pull/913)) + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Remove `.me` files ([#902](https://github.com/seek-oss/skuba/pull/902)) + + SEEK is moving away from Codex to off-the-shelf software powered by Backstage `catalog-info.yaml` files. + + At the moment we're only asking teams to document their systems, which typically span across multiple repositories. We may add `catalog-info.yaml` files back to the templates if there's a need for teams to document their components at a repository level. + +- [4.3.0](https://github.com/seek-oss/skuba/releases/tag/v4.3.0): Use ARM64 architecture ([#873](https://github.com/seek-oss/skuba/pull/873)) + + We now recommend building and running projects on ARM64 hardware for greater cost efficiency. This requires a Graviton-based Buildkite cluster; see our [ARM64 guide](https://seek-oss.github.io/skuba/docs/deep-dives/arm64.html) for more information. + +- [4.2.2](https://github.com/seek-oss/skuba/releases/tag/v4.2.2): Avoid mutation of logger context ([#879](https://github.com/seek-oss/skuba/pull/879)) + + We now perform a shallow copy when retrieving the logger context from `AsyncLocalStorage`. + + ```diff + - mixin: () => loggerContext.getStore() ?? {}, + + mixin: () => ({ ...loggerContext.getStore() }), + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Time out Buildkite test steps after 10 minutes ([#842](https://github.com/seek-oss/skuba/pull/842)) + + Successful testing and linting should complete within this window. This timeout prevents commands from hanging and indefinitely preoccupying your Buildkite agents. + + ```diff + steps: + - label: 🧪 Test & Lint + + timeout_in_minutes: 10 + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Change deployment method to `direct` ([#868](https://github.com/seek-oss/skuba/pull/868)) + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Use [AsyncLocalStorage](https://nodejs.org/docs/latest-v16.x/api/async_context.html#asynchronous-context-tracking) to track logger context ([#871](https://github.com/seek-oss/skuba/pull/871)) + + We now employ this Node.js API to thread logging context through the handler of your Lambda function. This enables use of a singleton `logger` instance instead of manually propagating Lambda context and juggling `rootLogger`s and `contextLogger`s, and is equivalent to #864. + + Before: + + ```typescript + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const rootLogger = createLogger(); + + const contextLogger = ({ awsRequestId }: Context) => + rootLogger.child({ awsRequestId }); + + const handler = async (_event: unknown, ctx: Context) => { + rootLogger.info('Has no context'); + + contextLogger(ctx).info('Has context'); + }; + ``` + + After: + + ```typescript + import { AsyncLocalStorage } from 'async_hooks'; + + import createLogger from '@seek/logger'; + import { Context } from 'aws-lambda'; + + const loggerContext = new AsyncLocalStorage<{ awsRequestId: string }>(); + + const logger = createLogger({ + mixin: () => ({ ...loggerContext.getStore() }), + }); + + const handler = (_event: unknown, { awsRequestId }: Context) => + loggerContext.run({ awsRequestId }, async () => { + logger.info('Has context'); + }); + ``` + +- [4.2.1](https://github.com/seek-oss/skuba/releases/tag/v4.2.1): Bump Node.js version to 16 ([#862](https://github.com/seek-oss/skuba/pull/862)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Fix progress configuration in `cdk.json` ([#797](https://github.com/seek-oss/skuba/pull/797)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Propagate Buildkite environment variables for lint autofixing ([#800](https://github.com/seek-oss/skuba/pull/800)) + +- [4.2.0](https://github.com/seek-oss/skuba/releases/tag/v4.2.0): Exclude DOM type definitions by default ([#822](https://github.com/seek-oss/skuba/pull/822)) + + TypeScript will now raise compiler errors when DOM globals like `document` and `window` are referenced in new projects. This catches unsafe usage of Web APIs that will throw exceptions in a Node.js context. + + If you are developing a new npm package for browser use or require specific Node.js-compatible Web APIs like the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), you can opt in to DOM type definitions in your `tsconfig.json`: + + ```diff + { + "compilerOptions": { + - "lib": ["ES2020"] + + "lib": ["DOM", "ES2020"] + } + } + ``` + + If you have an existing backend project, you can opt out of DOM type definitions in your `tsconfig.json`. + + For Node.js 14: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2020"], + "target": "ES2020" + } + } + ``` + + For Node.js 16: + + ```diff + { + "compilerOptions": { + + "lib": ["ES2021"], + "target": "ES2021" + } + } + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Disable type checking in tests ([#787](https://github.com/seek-oss/skuba/pull/787)) + + Newly initialised projects will skip TypeScript type checking on `skuba test` as it's already covered by `skuba lint`. You can now iterate on your tests without running into annoying compilation errors like TS6133 (unused declarations). + + This will be defaulted for existing projects in a future major version. You can opt in early by setting the `globals` configuration option in your `jest.config.ts`: + + ```typescript + export default Jest.mergePreset({ + globals: { + 'ts-jest': { + // seek-oss/skuba#626 + isolatedModules: true, + }, + }, + // Rest of config + }); + ``` + +- [4.1.1](https://github.com/seek-oss/skuba/releases/tag/v4.1.1): Specify default Buildkite agent ([#775](https://github.com/seek-oss/skuba/pull/775)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): skuba-dive ^2.0.0 ([#766](https://github.com/seek-oss/skuba/pull/766)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Remove `variablesResolutionMode` ([#768](https://github.com/seek-oss/skuba/pull/768)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Starting with v3.0, the "variablesResolutionMode" option is now useless. You can safely remove it from the configuration + More info: https://serverless.com/framework/docs/deprecations/#VARIABLES_RESOLUTION_MODE + ``` + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Add `NODE_ENV=production` to environment variables ([#763](https://github.com/seek-oss/skuba/pull/763)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Add `NODE_ENV=production` to environment variables ([#763](https://github.com/seek-oss/skuba/pull/763)) + +- [4.1.0](https://github.com/seek-oss/skuba/releases/tag/v4.1.0): Move environment variables to `provider.environment` to reduce repetition ([#767](https://github.com/seek-oss/skuba/pull/767)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Use `--enable-source-maps` ([#761](https://github.com/seek-oss/skuba/pull/761)) + + Stable source map support has landed in Node.js 14.18+ via the built-in `--enable-source-maps` option. + + We recommend migrating off of custom source map implementations in favour of this option. Upgrading to [**skuba-dive** v2](https://github.com/seek-oss/skuba-dive/releases/tag/v2.0.0) will remove `source-map-support` from the `skuba-dive/register` hook. + + For a containerised application, update your Dockerfile: + + ```diff + - FROM gcr.io/distroless/nodejs:12 AS runtime + + FROM gcr.io/distroless/nodejs:16 AS runtime + + + # https://nodejs.org/api/cli.html#cli_node_options_options + + ENV NODE_OPTIONS=--enable-source-maps + ``` + + For a Serverless Lambda application, update your `serverless.yml`: + + ```diff + provider: + - runtime: nodejs12.x + + runtime: nodejs14.x + + functions: + Worker: + environment: + + # https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: --enable-source-maps + ``` + + For a CDK Lambda application, update your stack: + + ```diff + new aws_lambda.Function(this, 'worker', { + - runtime: aws_lambda.Runtime.NODEJS_12_X, + + runtime: aws_lambda.Runtime.NODEJS_14_X, + environment: { + + // https://nodejs.org/api/cli.html#cli_node_options_options + + NODE_OPTIONS: '--enable-source-maps', + }, + }); + ``` + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Disable `tty` on deploy step ([#753](https://github.com/seek-oss/skuba/pull/753)) + + Serverless Framework v3 renders progress spinners on interactive terminals. We recommend disabling [tty](https://github.com/buildkite-plugins/docker-compose-buildkite-plugin#tty-optional-run-only) in CI/CD for cleaner log output. + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): serverless ^3.0.0 ([#748](https://github.com/seek-oss/skuba/pull/748)) + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Replace `custom.env` configuration with `params` ([#752](https://github.com/seek-oss/skuba/pull/752)) + + You can now define environment specific variables using the new Serverless parameters feature. See for more details. + +- [4.0.0](https://github.com/seek-oss/skuba/releases/tag/v4.0.0): Remove `provider.lambdaHashingVersion` ([#751](https://github.com/seek-oss/skuba/pull/751)) + + This resolves the following deprecation warning in Serverless Framework v3: + + ```console + Setting "20201221" for "provider.lambdaHashingVersion" is no longer effective as new hashing algorithm is now used by default. You can safely remove this property from your configuration. + ``` + +- [3.17.2](https://github.com/seek-oss/skuba/releases/tag/v3.17.2): Remove qualifier from smoke test invocation ([#743](https://github.com/seek-oss/skuba/pull/743)) + + Previously, this template's smoke test hook specified a `$LATEST` qualifier in its `Lambda.Invoke` API call. AWS authorised the call based on the unqualified Lambda ARN in our `serverless.yml` IAM policy, but will stop doing so after April 2022. + + To avoid deployment failures, remove the qualifier in `src/hooks.ts`. An unqualified call is equivalent to targeting `$LATEST`. + + ```diff + - Qualifier: '$LATEST', + + Qualifier: undefined, + ``` + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Retrieve GitHub token on Test & Lint ([#667](https://github.com/seek-oss/skuba/pull/667)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): serverless-prune-plugin ^2.0.0 ([#719](https://github.com/seek-oss/skuba/pull/719)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Migrate to AWS CDK v2 ([#714](https://github.com/seek-oss/skuba/pull/714)) + +- [3.17.0](https://github.com/seek-oss/skuba/releases/tag/v3.17.0): Fix docker-compose volume mount and deploy output ([#695](https://github.com/seek-oss/skuba/pull/695)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Use correct `environment` key in `docker-compose.yml` ([#654](https://github.com/seek-oss/skuba/pull/654)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Switch to ARM64 architecture ([#640](https://github.com/seek-oss/skuba/pull/640)) + + These are a bit cheaper and a bit faster than x86 Lambdas: + + + The underlying Lambda architecture should be invisible to typical TypeScript Lambdas. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Bump non-Lambda templates to Node.js 16 ([#633](https://github.com/seek-oss/skuba/pull/633)) + + Node.js 16 is now in active LTS. The Lambda templates are stuck on Node.js 14 until the new AWS Lambda runtime is released. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): seek-jobs/gantry v1.5.2 ([#634](https://github.com/seek-oss/skuba/pull/634)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): hot-shots ^9.0.0 ([#639](https://github.com/seek-oss/skuba/pull/639)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Remove `pino.Logger` indirection ([#624](https://github.com/seek-oss/skuba/pull/624)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): @seek/logger ^5.0.0 ([#621](https://github.com/seek-oss/skuba/pull/621)) + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Ignore `.gantry` YAML paths via `.prettierignore` ([#636](https://github.com/seek-oss/skuba/pull/636)) + + Gantry resource and value files often live in the `.gantry` subdirectory and may use non-standard template syntax. + +- [3.16.0](https://github.com/seek-oss/skuba/releases/tag/v3.16.0): Propagate environment variables for GitHub annotations ([#642](https://github.com/seek-oss/skuba/pull/642)) + + This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Convert Serverless `isProduction` config value to boolean ([#602](https://github.com/seek-oss/skuba/pull/602)) + + This avoids potentially surprising behaviour if you try to make use of this config value in a context that tests for truthiness. The boolean is still correctly applied as a string `seek:env:production` tag value. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Opt in to [new Serverless variables resolver](https://www.serverless.com/framework/docs/deprecations/#NEW_VARIABLES_RESOLVER) ([#601](https://github.com/seek-oss/skuba/pull/601)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Remove README tables of contents ([#596](https://github.com/seek-oss/skuba/pull/596)) + + GitHub's Markdown renderer now generates its own table of contents. + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): seek-jobs/gantry v1.5.1 ([#604](https://github.com/seek-oss/skuba/pull/604)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): Fail fast on invalid Serverless config ([#605](https://github.com/seek-oss/skuba/pull/605)) + +- [3.15.2](https://github.com/seek-oss/skuba/releases/tag/v3.15.2): pino-pretty ^6.0.0 ([#594](https://github.com/seek-oss/skuba/pull/594)) + + pino-pretty@7 requires pino@7, which has not been released on its stable channel yet. + +- [3.15.1](https://github.com/seek-oss/skuba/releases/tag/v3.15.1): Remove `unknown` specifier in catch clauses ([#580](https://github.com/seek-oss/skuba/pull/580)) + + Strict TypeScript 4.4 now defaults to typing catch clause variables as `unknown`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): pino-pretty ^7.0.0 ([#506](https://github.com/seek-oss/skuba/pull/506)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Configure environment variables and volume mounts for Buildkite annotations ([#558](https://github.com/seek-oss/skuba/pull/558)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): serverless-plugin-canary-deployments ^0.7.0 ([#508](https://github.com/seek-oss/skuba/pull/508)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Prime dev ECR cache in Buildkite pipeline ([#503](https://github.com/seek-oss/skuba/pull/503)) + + This should result in faster "Deploy Dev" times as the ECR cache will already be warm. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): seek-jobs/gantry v1.4.1 ([#504](https://github.com/seek-oss/skuba/pull/504)) + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove `@types/node` resolution override ([#498](https://github.com/seek-oss/skuba/pull/498)) + + Jest 27.1 is compatible with newer versions of `@types/node`. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Run "Test, Lint & Build" step in prod ([#503](https://github.com/seek-oss/skuba/pull/503)) + + This reduces our dependence on a dev environment to successfully deploy to prod. + +- [3.15.0](https://github.com/seek-oss/skuba/releases/tag/v3.15.0): Remove Yarn cache from worker Docker images ([#499](https://github.com/seek-oss/skuba/pull/499)) + + This shrinks the cached Docker images that our worker templates generate. + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): @types/node ^14.17.19 ([#490](https://github.com/seek-oss/skuba/pull/490)) + +- [3.14.4](https://github.com/seek-oss/skuba/releases/tag/v3.14.4): seek-jobs/gantry v1.4.0 ([#483](https://github.com/seek-oss/skuba/pull/483)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): seek-oss/docker-ecr-cache v1.11.0 ([#467](https://github.com/seek-oss/skuba/pull/467)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add `test:ci` script ([#473](https://github.com/seek-oss/skuba/pull/473)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Force `@jest/types` resolution to fix clean installs ([#468](https://github.com/seek-oss/skuba/pull/468)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use [Docker Build secrets](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) ([#476](https://github.com/seek-oss/skuba/pull/476)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Group Buildkite pipeline anchors ([#474](https://github.com/seek-oss/skuba/pull/474)) + + This provides a bit more structure to our `pipeline.yml`s and allows anchored plugins to be recognised by Renovate. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Default Docker Compose image to empty string ([#469](https://github.com/seek-oss/skuba/pull/469)) + + This suppresses Docker Compose CLI warnings and errors when running outside of Buildkite. + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Use BUILDKITE_PIPELINE_DEFAULT_BRANCH in `pipeline.yml` ([#475](https://github.com/seek-oss/skuba/pull/475)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Add placeholder test coverage configuration ([#472](https://github.com/seek-oss/skuba/pull/472)) + +- [3.14.3](https://github.com/seek-oss/skuba/releases/tag/v3.14.3): Build once upfront ([#477](https://github.com/seek-oss/skuba/pull/477)) + + This employs Buildkite [artifacts](https://buildkite.com/docs/pipelines/artifacts) to share compiled code with each subsequent deployment step. + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Set `memorySize` for smoke test hook to 128 MiB ([#457](https://github.com/seek-oss/skuba/pull/457)) + +- [3.14.2](https://github.com/seek-oss/skuba/releases/tag/v3.14.2): Reuse ECR cache in Docker Compose ([#453](https://github.com/seek-oss/skuba/pull/453)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): pino-pretty ^5.0.0 ([#441](https://github.com/seek-oss/skuba/pull/441)) + +- [3.14.1](https://github.com/seek-oss/skuba/releases/tag/v3.14.1): seek-jobs/gantry v1.3.0 ([#452](https://github.com/seek-oss/skuba/pull/452)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Banish `typeof undefined` syntax ([#429](https://github.com/seek-oss/skuba/pull/429)) + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Always build before deploy ([#428](https://github.com/seek-oss/skuba/pull/428)) + + This prevents stale compiled code from being cached and deployed from ECR. + +- [3.14.0](https://github.com/seek-oss/skuba/releases/tag/v3.14.0): Prune `devDependencies` instead of installing twice in Docker ([#435](https://github.com/seek-oss/skuba/pull/435)) + + The template-bundled Dockerfiles would previously run `yarn install` twice to build a separate stage for production `dependencies` only. These have been updated to correctly share the Yarn cache across stages and to use `yarn install --production` to perform offline pruning. + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): Trim CDK deployment output ([#423](https://github.com/seek-oss/skuba/pull/423)) + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): @types/node ^15.0.0 ([#422](https://github.com/seek-oss/skuba/pull/422)) + +- [3.13.1](https://github.com/seek-oss/skuba/releases/tag/v3.13.1): Fix npm token in Buildkite pipeline ([#423](https://github.com/seek-oss/skuba/pull/423)) + +
+ +[aws cdk]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346041/#CDK +[aws lambda]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346041/#Lambda-updated +[serverless]: https://serverless.com/ +[worker]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346236/#Worker diff --git a/index.md b/index.md new file mode 100644 index 000000000..f2df4515c --- /dev/null +++ b/index.md @@ -0,0 +1,72 @@ +--- +nav_order: 1 +title: 🤿 +--- + +# [![🤿 skuba](./docs/logo.svg)](https://seek-oss.github.io/skuba) + +--- + +[![GitHub Release](https://github.com/seek-oss/skuba/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/skuba/actions?query=workflow%3ARelease) +[![GitHub Validate](https://github.com/seek-oss/skuba/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/skuba/actions?query=workflow%3AValidate) +[![Node.js version](https://img.shields.io/badge/node-%3E%3D%2018.12-brightgreen)](https://nodejs.org/en/) +[![npm package](https://img.shields.io/npm/v/skuba)](https://www.npmjs.com/package/skuba) + +--- + +**skuba** is a toolkit for backend application and package development on SEEK's gravel and paved roads: + +- Write in [TypeScript] +- Enforce coding standards with [ESLint] and [Prettier] +- Test with [Jest] +- Deploy with [Gantry], [Serverless] or the [AWS CDK] + +[aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html +[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/ +[serverless]: https://serverless.com/ + +It provides you with: + +- [CLI] commands for developing your project +- [Templates] to base your backend application or package on +- [Development] and optional [runtime] APIs for cross-cutting concerns + +Learn more [about](docs/about.md) **skuba** and [contribute](CONTRIBUTING.md) to it. + +--- + +**skuba** is distributed as an npm package. + +In projects that list it as a `devDependency`, +usage may look something like this: + +```shell +# Install project dependencies. +yarn + +# Run the skuba CLI. +yarn skuba help +``` + +Global installations are also supported to speed up local development: + +```shell +# Install skuba globally. +yarn global add skuba + +# Look, no `npx`! +skuba help +``` + +If you're new here, jump ahead to the [CLI] section to [create a new project] or [update an existing one]. + +[cli]: ./docs/cli +[create a new project]: ./docs/cli/init.md +[development]: ./docs/development-api +[eslint]: https://eslint.org/ +[jest]: https://jestjs.io +[prettier]: https://prettier.io/ +[runtime]: ./docs/runtime-api +[templates]: ./docs/templates +[typescript]: https://www.typescriptlang.org/ +[update an existing one]: ./docs/cli/configure.md