v3.17.1

Patch Changes

• deps: ts-jest ^27.1.2 (#729)

  This resolves the following import issue in older 27.0.x versions of ts-jest:

  TypeError: pathsToModuleNameMapper is not a function

• test: Restore Node.js 12 compatibility (#730)

  This resolves the following error in Node.js 12 environments:

  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.

v3.17.0

Minor Changes

• template/koa-rest-api: Add opt-in OpenTelemetry support (#706)

• deps: Prettier 2.5 (#701)

  See the release notes for more information.

• node, start: Register tsconfig-paths (#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:

  // tsconfig.json
  {
    "compilerOptions": {
      "baseUrl": ".",
      "paths": {
        "src": ["src"]
      }
    }
  }

• GitHub.buildNameFromEnvironment: Export helper function (#676)

• jest: Support tsconfig.json paths (#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)

• test: Add GitHub check run annotations (#648)

  skuba test can now automatically annotate GitHub commits when you propagate CI environment variables and a GitHub API token. These annotations also appear inline with code under the “Files changed” tab in pull requests.

• GitHub.getPullRequestNumber: Export helper function (#690)

• GitHub.putIssueComment: Export helper function (#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)

Patch Changes

• GitHub.createCheckRun: Support text parameter (#673)

• template: Retrieve GitHub token on Test & Lint (#667)

• template: serverless-prune-plugin ^2.0.0 (#719)

• test: Fix ts-jest imports (#715)

  This resolves the following warning:

  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:

  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)

• node, start: Deregister source-map-support (#679)

  ts-node takes care of this for us.

• template/lambda-sqs-worker-cdk: Fix docker-compose volume mount and deploy output (#695)

• Jest.mergePreset: Allow displayName and projects (#648)

v3.17.0-beta.5

Patch Changes

• jest: Fix undefined reference (99eaae1)

v3.17.0-beta.4

Patch Changes

• pkg: Include jest subdirectory (f38556c)

v3.17.0-beta.3

Minor Changes

• jest: Support tsconfig.json paths (fe4ed57)

  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.

v3.17.0-beta.0

Minor Changes

• node, start: Register tsconfig-paths (#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:

  // tsconfig.json
  {
    "compilerOptions": {
      "baseUrl": ".",
      "paths": {
        "src": ["src"]
      }
    }
  }

• GitHub.buildNameFromEnvironment: Export helper function (#676)

• git: Export helper functions (#689)

• test: Add GitHub check run annotations (#648)

  skuba test can now automatically annotate GitHub commits when you propagate CI environment variables and a GitHub API token. These annotations also appear inline with code under the “Files changed” tab in pull requests.

• GitHub.getPullRequestNumber: Export helper function (#690)

• GitHub.putIssueComment: Export helper function (#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)

Patch Changes

• GitHub.createCheckRun: Support text parameter (#673)

• template: Retrieve GitHub token on Test & Lint (#667)

• deps: TypeScript 4.5 (#685)

  This major release includes breaking changes. See the announcement for more information.

  Note that new syntax in TypeScript 4.5 is not yet supported by ESLint and Prettier.

• node, start: Deregister source-map-support (#679)

  ts-node takes care of this for us.

• Jest.mergePreset: Allow displayName and projects (#648)

v3.16.2

Patch Changes

• format, lint: Skip reading unsupported Prettier files into memory (#662)

• format, lint: Fix file descriptor warnings (#664)

  This resolves the following warning when processing files that Prettier cannot parse:

  (node:123) Warning: File descriptor 456 closed but not opened in unmanaged mode

v3.16.1

Patch Changes

• deps: Include @octokit/types (#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'.
  

v3.16.0

Minor Changes

• GitHub.createCheckRun: Add development API for writing annotations (#625)

• lint: Add GitHub check run annotations (#625)

  skuba lint can now automatically annotate GitHub commits when you propagate Buildkite environment variables and a GitHub API token. These annotations also appear inline with code under the “Files changed” tab in pull requests.

• format, lint: Enable ESLint caching (#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)

  This adds a couple new linting rules:

  • jest/prefer-expect-resolves
  • jest/prefer-to-be

  Run skuba format to automatically align your code with these rules.

• format, lint: Synchronise ignore files (#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)

• template/lambda-sqs-worker: Switch to ARM64 architecture (#640)

  These are a bit cheaper and a bit faster than x86 Lambdas:
  https://aws.amazon.com/blogs/aws/aws-lambda-functions-powered-by-aws-graviton2-processor-run-your-functions-on-arm-and-get-up-to-34-better-price-performance/

  The underlying Lambda architecture should be invisible to typical TypeScript Lambdas.

• template: Bump non-Lambda templates to Node.js 16 (#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)

• deps: typescript 4.4.4 (#616)

• start: Add a ? placeholder for unnamed function arguments (#647)

• deps: Relax ranges (#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)

• template/lambda-sqs-worker: Remove pino.Logger indirection (#624)

• template: @seek/logger ^5.0.0 (#621)

• template: Ignore .gantry YAML paths via .prettierignore (#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)

  This enables GitHub annotations for newly-initialised projects with the appropriate Buildkite configuration.

v3.15.3-beta.0

Patch Changes

• template: Bump non-Lambda templates to Node.js 16 (#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)

• deps: typescript 4.4.4 (#616)

• deps: Relax ranges (#622)

  Projects can now upgrade to new Prettier and TypeScript patches and ts-node-dev minors without us having to cut a new release.

• deps: eslint-config-skuba 1.0.12 (#623)

• template: hot-shots ^9.0.0 (#639)

• template/lambda-sqs-worker: Remove pino.Logger indirection (#624)

• template: @seek/logger ^5.0.0 (#621)

• template: Ignore .gantry YAML paths via .prettierignore (#636)

  Gantry resource and value files often live in the .gantry subdirectory and may use non-standard template syntax.