Skip to content

Commit 97e5eb9

Browse files
leodidoona-agent
andcommitted
docs(readme): document exportToCache field and SLSA L3 usage
Update Docker packages section in README with exportToCache field documentation and SLSA Level 3 compliance information. Changes: - Add exportToCache field to YAML example with inline comments - Document default behavior (false = legacy push) - Document export mode (true = cache for signing) - Note override mechanisms (CLI flag and env var) - Add SLSA L3 compliance section with usage examples - Reference to 'leeway build --help' for details Documentation follows existing README patterns with concise explanations and practical examples. Co-authored-by: Ona <[email protected]>
1 parent 87d9fb5 commit 97e5eb9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ config:
170170
config:
171171
# Dockerfile is the name of the Dockerfile to build. Automatically added to the package sources.
172172
dockerfile: "Dockerfile"
173+
# exportToCache controls whether images are pushed directly or exported to cache
174+
# - false (default): push directly to registry (legacy behavior)
175+
# - true: export to cache for signing (enables SLSA L3 compliance)
176+
# Can be overridden via --docker-export-to-cache flag or LEEWAY_DOCKER_EXPORT_TO_CACHE env var
177+
exportToCache: false
173178
# Metadata produces a metadata.yaml file in the resulting package tarball.
174179
metadata:
175180
foo: bar
@@ -191,6 +196,12 @@ The name of this build argument is the package name of the dependency, transform
191196

192197
E.g. `component/nested:docker` becomes `COMPONENT_NESTED__DOCKER`.
193198

199+
**For SLSA Level 3 compliance:** Set `exportToCache: true` to enable cache-based Docker image distribution with cryptographic signing. This can be overridden globally using:
200+
- CLI flag: `leeway build --docker-export-to-cache`
201+
- Environment variable: `LEEWAY_DOCKER_EXPORT_TO_CACHE=true`
202+
203+
See `leeway build --help` for more details.
204+
194205
### Generic packages
195206
```YAML
196207
config:

0 commit comments

Comments
 (0)