Skip to content

Commit 2e5c7f4

Browse files
committed
Document free-space flag
1 parent 5529328 commit 2e5c7f4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,17 @@ RUN --mount=type=secret,id=NPM_TOKEN \
113113
If `true`, the action uses the built-in GitHub Actions cache to to store Docker build layers between runs.
114114
However, this cache appears to have a race condition when used across multiple architectures so that only one architecture is effectively cached.
115115
Disabling caching altogether at least avoids the time cost of uploading and downloading the cache.
116-
If the image being built is very large, `false` might be preferable, as the total cache size is 10GB as of October 2025.
117116

118117
- `push` (boolean, optional) a flag to enable pushing to artifact registries (based on the `image` input) .
119118
Default is `true`.
120119
If `false`, the action skips the image push, but still builds the image with [`docker build`](https://docs.docker.com/engine/reference/commandline/build/).
121120
In that case the action does not perform the manifest reassembly across platforms.
122121

122+
- `free-space` (boolean, optional) a flag to remove the .NET, Android SDK, Haskell, and CodeQL directories.
123+
If your builds are running out of space, try this.
124+
Default is `false`.
125+
This saves 18GB on amd64 (only 3GB on arm64).
126+
123127
- `target` (string, optional) the name of a build stage in the Dockerfile to target for the image. This allows multiple images built from a single Dockerfile, e.g., "runtime-A" and "runtime-B".
124128

125129
- `fetch-depth` (number, optional) the git checkout fetch-depth. Set to 0 for complete history, which some builds require.

0 commit comments

Comments
 (0)