From 5c2170faec6e4292db9e212310931ec6ccf1a217 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 31 Oct 2023 03:40:49 +0000 Subject: [PATCH] Version Packages --- .changeset/breezy-bees-judge.md | 55 -------------- .changeset/breezy-radios-compare.md | 5 -- .changeset/calm-tips-wait.md | 12 --- .changeset/chilly-chairs-wash.md | 7 -- .changeset/four-bottles-itch.md | 9 --- .changeset/heavy-buses-tease.md | 5 -- .changeset/nasty-bees-smash.md | 7 -- .changeset/pretty-baboons-brake.md | 12 --- .changeset/selfish-deers-pretend.md | 7 -- .changeset/seven-peas-tease.md | 7 -- .changeset/smooth-boxes-move.md | 11 --- CHANGELOG.md | 110 ++++++++++++++++++++++++++++ package.json | 2 +- 13 files changed, 111 insertions(+), 138 deletions(-) delete mode 100644 .changeset/breezy-bees-judge.md delete mode 100644 .changeset/breezy-radios-compare.md delete mode 100644 .changeset/calm-tips-wait.md delete mode 100644 .changeset/chilly-chairs-wash.md delete mode 100644 .changeset/four-bottles-itch.md delete mode 100644 .changeset/heavy-buses-tease.md delete mode 100644 .changeset/nasty-bees-smash.md delete mode 100644 .changeset/pretty-baboons-brake.md delete mode 100644 .changeset/selfish-deers-pretend.md delete mode 100644 .changeset/seven-peas-tease.md delete mode 100644 .changeset/smooth-boxes-move.md diff --git a/.changeset/breezy-bees-judge.md b/.changeset/breezy-bees-judge.md deleted file mode 100644 index 50079ff81..000000000 --- a/.changeset/breezy-bees-judge.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -'skuba': minor ---- - -Jest.mergePreset: Propagate root-level configuration options to `projects` - -[`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. diff --git a/.changeset/breezy-radios-compare.md b/.changeset/breezy-radios-compare.md deleted file mode 100644 index 9ce6995d6..000000000 --- a/.changeset/breezy-radios-compare.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -Git: Handle non-root working directories in [`commitAllChanges`](https://seek-oss.github.io/skuba/docs/development-api/git.html#commitallchanges) diff --git a/.changeset/calm-tips-wait.md b/.changeset/calm-tips-wait.md deleted file mode 100644 index c852a982f..000000000 --- a/.changeset/calm-tips-wait.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'skuba': patch ---- - -template/koa-rest-api: Fix `app.test.ts` assertions - -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)); -``` diff --git a/.changeset/chilly-chairs-wash.md b/.changeset/chilly-chairs-wash.md deleted file mode 100644 index 398738e8e..000000000 --- a/.changeset/chilly-chairs-wash.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'skuba': minor ---- - -Net.waitFor: Use Docker Compose V2 - -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. diff --git a/.changeset/four-bottles-itch.md b/.changeset/four-bottles-itch.md deleted file mode 100644 index c6b54b588..000000000 --- a/.changeset/four-bottles-itch.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'skuba': patch ---- - -template: seek-oss/docker-ecr-cache 2.1 - -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. diff --git a/.changeset/heavy-buses-tease.md b/.changeset/heavy-buses-tease.md deleted file mode 100644 index c187e3871..000000000 --- a/.changeset/heavy-buses-tease.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'skuba': patch ---- - -lint: Resolve infinite autofix loop diff --git a/.changeset/nasty-bees-smash.md b/.changeset/nasty-bees-smash.md deleted file mode 100644 index 53202b5b3..000000000 --- a/.changeset/nasty-bees-smash.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'skuba': minor ---- - -lint: Add `prettier-plugin-packagejson` - -This Prettier plugin sorts and formats your `package.json` file. diff --git a/.changeset/pretty-baboons-brake.md b/.changeset/pretty-baboons-brake.md deleted file mode 100644 index 7686a5bc7..000000000 --- a/.changeset/pretty-baboons-brake.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'skuba': patch ---- - -GitHub: Add working directory parameter to [`readFileChanges`](https://seek-oss.github.io/skuba/docs/development-api/github.html#readfilechanges) - -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) -``` diff --git a/.changeset/selfish-deers-pretend.md b/.changeset/selfish-deers-pretend.md deleted file mode 100644 index bbd521ed4..000000000 --- a/.changeset/selfish-deers-pretend.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'skuba': patch ---- - -lint: Handle non-root working directories in autofix commits - -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. diff --git a/.changeset/seven-peas-tease.md b/.changeset/seven-peas-tease.md deleted file mode 100644 index a77e8a410..000000000 --- a/.changeset/seven-peas-tease.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'skuba': patch ---- - -cli: Migrate from Runtypes to Zod - -The skuba CLI now uses Zod internally. This should not result in noticeable differences for consumers. diff --git a/.changeset/smooth-boxes-move.md b/.changeset/smooth-boxes-move.md deleted file mode 100644 index 76da14b1e..000000000 --- a/.changeset/smooth-boxes-move.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'skuba': patch ---- - -template: Mount npm build secret to a separate directory - -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. diff --git a/CHANGELOG.md b/CHANGELOG.md index 617b87e85..566bb90d9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,115 @@ # skuba +## 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 diff --git a/package.json b/package.json index 523e0867d..1cecedd55 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "skuba", - "version": "7.2.0", + "version": "7.3.0", "private": false, "description": "SEEK development toolkit for backend applications and packages", "homepage": "https://github.com/seek-oss/skuba#readme",