Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,11 @@ config:
config:
# Dockerfile is the name of the Dockerfile to build. Automatically added to the package sources.
dockerfile: "Dockerfile"
# exportToCache controls whether images are pushed directly or exported to cache
# - false (default): push directly to registry (legacy behavior)
# - true: export to cache for signing (enables SLSA L3 compliance)
# Can be overridden via --docker-export-to-cache flag or LEEWAY_DOCKER_EXPORT_TO_CACHE env var
exportToCache: false
# Metadata produces a metadata.yaml file in the resulting package tarball.
metadata:
foo: bar
Expand All @@ -191,6 +196,12 @@ The name of this build argument is the package name of the dependency, transform

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

**For SLSA Level 3 compliance:** Set `exportToCache: true` to enable cache-based Docker image distribution with cryptographic signing. This can be overridden globally using:
- CLI flag: `leeway build --docker-export-to-cache`
- Environment variable: `LEEWAY_DOCKER_EXPORT_TO_CACHE=true`

See `leeway build --help` for more details.

### Generic packages
```YAML
config:
Expand Down
41 changes: 40 additions & 1 deletion cmd/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,24 @@ import (
var buildCmd = &cobra.Command{
Use: "build [targetPackage]",
Short: "Builds a package",
Args: cobra.MaximumNArgs(1),
Long: `Builds a package and all its dependencies.

Docker Export Mode:
By default, Docker packages with 'image' configuration push directly to registries.
Use --docker-export-to-cache to export images to cache instead (enables SLSA L3).

The LEEWAY_DOCKER_EXPORT_TO_CACHE environment variable sets the default for the flag.

Examples:
# Build with Docker export mode enabled (CLI flag)
leeway build --docker-export-to-cache :myapp

# Build with Docker export mode enabled (environment variable)
LEEWAY_DOCKER_EXPORT_TO_CACHE=true leeway build :myapp

# Disable export mode even if env var is set
leeway build --docker-export-to-cache=false :myapp`,
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
_, pkg, _, _ := getTarget(args, false)
if pkg == nil {
Expand Down Expand Up @@ -190,6 +207,7 @@ func addBuildFlags(cmd *cobra.Command) {
cmd.Flags().String("report-segment", os.Getenv("LEEWAY_SEGMENT_KEY"), "Report build events to segment using the segment key (defaults to $LEEWAY_SEGMENT_KEY)")
cmd.Flags().Bool("report-github", os.Getenv("GITHUB_OUTPUT") != "", "Report package build success/failure to GitHub Actions using the GITHUB_OUTPUT environment variable")
cmd.Flags().Bool("fixed-build-dir", true, "Use a fixed build directory for each package, instead of based on the package version, to better utilize caches based on absolute paths (defaults to true)")
cmd.Flags().Bool("docker-export-to-cache", false, "Export Docker images to cache instead of pushing directly (enables SLSA L3 compliance)")
}

func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
Expand Down Expand Up @@ -330,6 +348,26 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
inFlightChecksums = inFlightChecksumsDefault
}

// Get docker export to cache setting with proper precedence:
// 1. CLI flag (if explicitly set)
// 2. Environment variable (if set)
// 3. Package config (default)
dockerExportToCache := false
dockerExportSet := false

if cmd.Flags().Changed("docker-export-to-cache") {
// Flag was explicitly set by user - this takes precedence
dockerExportToCache, err = cmd.Flags().GetBool("docker-export-to-cache")
if err != nil {
log.Fatal(err)
}
dockerExportSet = true
} else if envVal := os.Getenv("LEEWAY_DOCKER_EXPORT_TO_CACHE"); envVal != "" {
// Env var set (flag not set) - env var takes precedence over package config
dockerExportToCache = envVal == "true" || envVal == "1"
dockerExportSet = true
}

return []leeway.BuildOption{
leeway.WithLocalCache(localCache),
leeway.WithRemoteCache(remoteCache),
Expand All @@ -345,6 +383,7 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
leeway.WithFixedBuildDir(fixedBuildDir),
leeway.WithDisableCoverage(disableCoverage),
leeway.WithInFlightChecksums(inFlightChecksums),
leeway.WithDockerExportToCache(dockerExportToCache, dockerExportSet),
}, localCache
}

Expand Down
Loading