Skip to content

Commit d8194ff

Browse files
committed
Update README
1 parent 50f5a67 commit d8194ff

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ You can run `docker build` and `docker-compose build` in your GitHub Actions wor
77

88
This GitHub Action uses the [docker save](https://docs.docker.com/engine/reference/commandline/save/) / [docker load](https://docs.docker.com/engine/reference/commandline/load/) command and the [@actions/cache](https://www.npmjs.com/package/@actions/cache) library.
99

10+
## ⚠️ **Deprecation Notice for `v0.0.4` and older** ⚠️
11+
12+
The author had not taken into account that a large number of layers would be cached,
13+
so those versions processes all layers in parallel. ([#12](https://github.com/satackey/action-docker-layer-caching/issues/12))
14+
**Please update to version `v0.0.5` with limited concurrency to avoid overloading the cache service.**
1015

1116
## Example workflows
1217

@@ -30,11 +35,11 @@ jobs:
3035
# In this step, this action saves a list of existing images,
3136
# the cache is created without them in the post run.
3237
# It also restores the cache if it exists.
33-
- uses: satackey/action-docker-layer-caching@v0.0.4
38+
- uses: satackey/action-docker-layer-caching@v0.0.5
3439

3540
- run: docker-compose up --build
3641

37-
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.4",
42+
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.5",
3843
# which is the process of saving the cache, will be executed.
3944
```
4045

@@ -56,12 +61,12 @@ jobs:
5661
# In this step, this action saves a list of existing images,
5762
# the cache is created without them in the post run.
5863
# It also restores the cache if it exists.
59-
- uses: satackey/action-docker-layer-caching@v0.0.4
64+
- uses: satackey/action-docker-layer-caching@v0.0.5
6065

6166
- name: Build the Docker image
6267
run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)
6368

64-
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.4",
69+
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.5",
6570
# which is the process of saving the cache, will be executed.
6671
```
6772

@@ -74,7 +79,7 @@ By default, the cache is separated by the workflow name.
7479
You can also set the cache key manually, like the official [actions/cache](https://github.com/actions/cache#usage) action.
7580

7681
```yaml
77-
- uses: satackey/action-docker-layer-caching@v0.0.4
82+
- uses: satackey/action-docker-layer-caching@v0.0.5
7883
with:
7984
key: foo-docker-cache-{hash}
8085
restore-keys: |

0 commit comments

Comments
 (0)