Skip to content

Commit afdbf15

Browse files
committed
docs: add OCI export requirements to README
Document docker-container builder requirement for OCI export. Clarify that docker/setup-buildx-action uses docker-container by default.
1 parent b12cf22 commit afdbf15

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,11 @@ E.g. `component/nested:docker` becomes `COMPONENT_NESTED__DOCKER`.
200200
- CLI flag: `leeway build --docker-export-to-cache`
201201
- Environment variable: `LEEWAY_DOCKER_EXPORT_TO_CACHE=true`
202202

203+
**Requirements for OCI export (`exportToCache: true`):**
204+
- Docker Buildx with `docker-container` driver (the default `docker` driver does not support OCI export)
205+
- **Local development:** Create a builder with `docker buildx create --name leeway-builder --driver docker-container --bootstrap && docker buildx use leeway-builder`
206+
- **CI/CD:** Use `docker/setup-buildx-action` which automatically creates a `docker-container` builder by default
207+
203208
See `leeway build --help` for more details.
204209

205210
### Generic packages

0 commit comments

Comments
 (0)