Skip to content

Commit

Permalink
template: seek-oss/docker-ecr-cache v2.2.0 (#1522)
Browse files Browse the repository at this point in the history
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: samchungy <samchungy@gmail.com>
Co-authored-by: Ryan Ling <ryan@outlook.com.au>
  • Loading branch information
3 people committed Apr 9, 2024
1 parent fe83a2c commit 4779a56
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 26 deletions.
7 changes: 4 additions & 3 deletions .changeset/early-sloths-deliver.md
Expand Up @@ -27,13 +27,14 @@ Corepack is about to download https://registry.npmjs.org/pnpm/-/pnpm-8.15.4.tgz.
Do you want to continue? [Y/n]
```

To avoid this issue, modify (1) Buildkite pipelines to cache on `package.json`, and (2) Dockerfiles to mount `package.json` and run `corepack install`:
To avoid this issue, modify (1) Buildkite pipelines to cache on the [`packageManager` property](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin/releases/tag/v2.2.0) in `package.json`, and (2) Dockerfiles to mount `package.json` and run `corepack install`:

```diff
seek-oss/docker-ecr-cache#v2.1.0:
- seek-oss/docker-ecr-cache#v2.1.0:
+ seek-oss/docker-ecr-cache#v2.2.0:
cache-on:
- .npmrc
+ - package.json
+ - package.json#.packageManager
- pnpm-lock.yaml
```

Expand Down
22 changes: 13 additions & 9 deletions docs/deep-dives/pnpm.md
Expand Up @@ -283,22 +283,26 @@ This migration guide assumes that your project was scaffolded with a **skuba** t

Swap out caching on `yarn.lock` for `.npmrc` and `pnpm-lock.yaml` at the same time.

We are also using an updated caching syntax on `package.json` which caches only on the `packageManager` key. This requires the [seek-oss/docker-ecr-cache](https://github.com/seek-oss/docker-ecr-cache-buildkite-plugin) plugin version to be >= 2.2.0.

```diff
seek-oss/private-npm#v1.2.0:
env: NPM_READ_TOKEN
+ output-path: tmp/
```

```diff
seek-oss/docker-ecr-cache#v2.1.0:
cache-on:
+ - .npmrc
- package.json
- - yarn.lock
+ - pnpm-lock.yaml
dockerfile: Dockerfile.dev-deps
- secrets: id=npm,src=.npmrc
+ secrets: id=npm,src=tmp/.npmrc
-聽seek-oss/docker-ecr-cache#v2.1.0:
+ seek-oss/docker-ecr-cache#v2.2.0:
cache-on:
+ - .npmrc
- - package.json
+ - package.json#.packageManager
- - yarn.lock
+ - pnpm-lock.yaml
dockerfile: Dockerfile.dev-deps
- secrets: id=npm,src=.npmrc
+ secrets: id=npm,src=tmp/.npmrc
```

16. Run `pnpm install --offline` and replace `yarn` with `pnpm` in `.buildkite/pipeline.yml`
Expand Down
6 changes: 3 additions & 3 deletions template/express-rest-api/.buildkite/pipeline.yml
Expand Up @@ -9,10 +9,10 @@ configs:
NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token

- &docker-ecr-cache
seek-oss/docker-ecr-cache#v2.1.1: &docker-ecr-cache-defaults
seek-oss/docker-ecr-cache#v2.2.0: &docker-ecr-cache-defaults
cache-on:
- .npmrc
- package.json
- package.json#.packageManager
- pnpm-lock.yaml
dockerfile: Dockerfile.dev-deps
secrets: id=npm,src=tmp/.npmrc
Expand All @@ -38,7 +38,7 @@ steps:
plugins:
- *aws-sm
- *private-npm
- seek-oss/docker-ecr-cache#v2.1.1:
- seek-oss/docker-ecr-cache#v2.2.0:
<<: *docker-ecr-cache-defaults
skip-pull-from-cache: true

Expand Down
4 changes: 2 additions & 2 deletions template/greeter/.buildkite/pipeline.yml
Expand Up @@ -11,10 +11,10 @@ configs:
NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token

- &docker-ecr-cache
seek-oss/docker-ecr-cache#v2.1.1:
seek-oss/docker-ecr-cache#v2.2.0:
cache-on:
- .npmrc
- package.json
- package.json#.packageManager
- pnpm-lock.yaml
secrets: id=npm,src=tmp/.npmrc

Expand Down
6 changes: 3 additions & 3 deletions template/koa-rest-api/.buildkite/pipeline.yml
Expand Up @@ -9,10 +9,10 @@ configs:
NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token

- &docker-ecr-cache
seek-oss/docker-ecr-cache#v2.1.1: &docker-ecr-cache-defaults
seek-oss/docker-ecr-cache#v2.2.0: &docker-ecr-cache-defaults
cache-on:
- .npmrc
- package.json
- package.json#.packageManager
- pnpm-lock.yaml
dockerfile: Dockerfile.dev-deps
secrets: id=npm,src=tmp/.npmrc
Expand All @@ -38,7 +38,7 @@ steps:
plugins:
- *aws-sm
- *private-npm
- seek-oss/docker-ecr-cache#v2.1.1:
- seek-oss/docker-ecr-cache#v2.2.0:
<<: *docker-ecr-cache-defaults
skip-pull-from-cache: true

Expand Down
6 changes: 3 additions & 3 deletions template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml
Expand Up @@ -9,10 +9,10 @@ configs:
NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token

- &docker-ecr-cache
seek-oss/docker-ecr-cache#v2.1.1: &docker-ecr-cache-defaults
seek-oss/docker-ecr-cache#v2.2.0: &docker-ecr-cache-defaults
cache-on:
- .npmrc
- package.json
- package.json#.packageManager
- pnpm-lock.yaml
secrets: id=npm,src=tmp/.npmrc

Expand Down Expand Up @@ -78,7 +78,7 @@ steps:
plugins:
- *aws-sm
- *private-npm
- seek-oss/docker-ecr-cache#v2.1.1:
- seek-oss/docker-ecr-cache#v2.2.0:
<<: *docker-ecr-cache-defaults
skip-pull-from-cache: true

Expand Down
6 changes: 3 additions & 3 deletions template/lambda-sqs-worker/.buildkite/pipeline.yml
Expand Up @@ -9,10 +9,10 @@ configs:
NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token

- &docker-ecr-cache
seek-oss/docker-ecr-cache#v2.1.1: &docker-ecr-cache-defaults
seek-oss/docker-ecr-cache#v2.2.0: &docker-ecr-cache-defaults
cache-on:
- .npmrc
- package.json
- package.json#.packageManager
- pnpm-lock.yaml
secrets: id=npm,src=tmp/.npmrc

Expand Down Expand Up @@ -82,7 +82,7 @@ steps:
plugins:
- *aws-sm
- *private-npm
- seek-oss/docker-ecr-cache#v2.1.1:
- seek-oss/docker-ecr-cache#v2.2.0:
<<: *docker-ecr-cache-defaults
skip-pull-from-cache: true

Expand Down

0 comments on commit 4779a56

Please sign in to comment.