Skip to content

Commit e85ca06

Browse files
authored
Update readme (#52)
1 parent f8e70fb commit e85ca06

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ steps:
2828
- command: echo wow
2929
plugins:
3030
- seek-oss/docker-ecr-cache#v2.2.0
31-
- docker#v3.12.0
31+
- docker#v5.10.0
3232
```
3333
3434
### Caching npm packages
@@ -38,25 +38,25 @@ without worrying about Docker layer cache invalidation. You do this by hinting
3838
when the image should be re-built.
3939

4040
```dockerfile
41-
FROM node:10-alpine
41+
FROM node:20-alpine
4242
4343
WORKDIR /workdir
4444
45-
COPY package.json package-lock.json /workdir
45+
COPY package.json pnpm-lock.yaml /workdir
4646
4747
# this step downloads the internet
48-
RUN npm install
48+
RUN pnpm install
4949
```
5050

5151
```yaml
5252
steps:
53-
- command: npm test
53+
- command: pnpm test
5454
plugins:
5555
- seek-oss/docker-ecr-cache#v2.2.0:
5656
cache-on:
5757
- package.json # avoid cache hits on stale lockfiles
58-
- package-lock.json
59-
- docker#v3.12.0:
58+
- pnpm-lock.yaml
59+
- docker#v5.10.0:
6060
volumes:
6161
- /workdir/node_modules
6262
```
@@ -65,13 +65,13 @@ The `cache-on` property also supports Bash globbing with `globstar`:
6565

6666
```yaml
6767
steps:
68-
- command: npm test
68+
- command: pnpm test
6969
plugins:
7070
- seek-oss/docker-ecr-cache#v2.2.0:
7171
cache-on:
7272
- '**/package.json' # monorepo with multiple manifest files
73-
- yarn.lock
74-
- docker#v3.12.0:
73+
- pnpm-lock.yaml
74+
- docker#v5.10.0:
7575
volumes:
7676
- /workdir/node_modules
7777
```
@@ -92,7 +92,7 @@ steps:
9292
- package.json#.packageManager
9393
- package.json#.pnpm.overrides
9494
- pnpm-lock.yaml
95-
- docker#v3.12.0:
95+
- docker#v5.10.0:
9696
volumes:
9797
- /workdir/node_modules
9898
```
@@ -107,7 +107,7 @@ steps:
107107
plugins:
108108
- seek-oss/docker-ecr-cache#v2.2.0:
109109
dockerfile: my-dockerfile
110-
- docker#v3.12.0
110+
- docker#v5.10.0
111111
```
112112

113113
Alternatively, Dockerfile can be embedded inline:
@@ -118,12 +118,12 @@ steps:
118118
plugins:
119119
- seek-oss/docker-ecr-cache#v2.2.0:
120120
dockerfile-inline: |
121-
FROM node:16-alpine
121+
FROM node:20-alpine
122122
WORKDIR /workdir
123-
COPY package.json package-lock.json /workdir
124-
RUN npm install
123+
COPY package.json pnpm-lock.yaml /workdir
124+
RUN pnpm install
125125
126-
- docker#v3.12.0
126+
- docker#v5.10.0
127127
```
128128

129129
### Building on the resulting image
@@ -175,7 +175,7 @@ steps:
175175
plugins:
176176
- seek-oss/docker-ecr-cache#v2.2.0:
177177
target: build-deps
178-
- docker#v3.12.0
178+
- docker#v5.10.0
179179
```
180180

181181
### Specifying build context
@@ -191,7 +191,7 @@ steps:
191191
- seek-oss/docker-ecr-cache#v2.2.0:
192192
dockerfile: dockerfiles/test/Dockerfile
193193
context: '.'
194-
- docker#v3.12.0
194+
- docker#v5.10.0
195195
```
196196

197197
### Specifying build args
@@ -221,7 +221,7 @@ steps:
221221
build-args:
222222
- ARG_1
223223
- ARG_2=such
224-
- docker#v3.12.0
224+
- docker#v5.10.0
225225
```
226226

227227
Additional `docker build` arguments be passed via the `additional-build-args` setting:
@@ -234,7 +234,7 @@ steps:
234234
plugins:
235235
- seek-oss/docker-ecr-cache#v2.2.0:
236236
additional-build-args: '--ssh= default=\$SSH_AUTH_SOCK'
237-
- docker#v3.12.0
237+
- docker#v5.10.0
238238
```
239239

240240
### Specifying secrets
@@ -263,7 +263,7 @@ steps:
263263
- seek-oss/docker-ecr-cache#v2.2.0:
264264
secrets:
265265
- SECRET
266-
- docker#v3.12.0
266+
- docker#v5.10.0
267267
```
268268

269269
You can also specify the full `--secret` flag value if you need more control:
@@ -279,7 +279,7 @@ steps:
279279
- seek-oss/docker-ecr-cache#v2.2.0:
280280
secrets:
281281
- id=npmrc,src=.npmrc
282-
- docker#v3.12.0
282+
- docker#v5.10.0
283283
```
284284

285285
You must have a recent version of Docker with BuildKit support to use secrets.
@@ -296,7 +296,7 @@ steps:
296296
plugins:
297297
- seek-oss/docker-ecr-cache#v2.2.0:
298298
max-age-days: 7
299-
- docker#v3.12.0
299+
- docker#v5.10.0
300300
```
301301

302302
### Changing the name of exported variable
@@ -342,7 +342,7 @@ steps:
342342
ecr-tags:
343343
Key: Value
344344
Key2: Value2
345-
- docker#v3.12.0
345+
- docker#v5.10.0
346346
```
347347

348348
#### Specifying a region
@@ -355,7 +355,7 @@ steps:
355355
plugins:
356356
- seek-oss/docker-ecr-cache#v2.2.0:
357357
region: ap-southeast-2
358-
- docker#v3.12.0
358+
- docker#v5.10.0
359359
```
360360

361361
#### Required permissions

0 commit comments

Comments
 (0)