Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bake: deprecate x-bake compose extension #3025

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
28 changes: 18 additions & 10 deletions bake/compose.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
dockeropts "github.com/docker/cli/opts"
"github.com/docker/go-units"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"gopkg.in/yaml.v3"
)

Expand Down Expand Up @@ -55,6 +56,7 @@ func ParseCompose(cfgs []composetypes.ConfigFile, envs map[string]string) (*Conf
}

var c Config
var xbakeSet bool
if len(cfg.Services) > 0 {
c.Groups = []*Group{}
c.Targets = []*Target{}
Expand Down Expand Up @@ -179,8 +181,10 @@ func ParseCompose(cfgs []composetypes.ConfigFile, envs map[string]string) (*Conf
ShmSize: shmSize,
Ulimits: ulimits,
}
if err = t.composeExtTarget(s.Build.Extensions); err != nil {
if set, err := t.composeExtTarget(s.Build.Extensions); err != nil {
return nil, err
} else if set {
xbakeSet = true
}
if s.Build.Target != "" {
target := s.Build.Target
Expand All @@ -194,6 +198,10 @@ func ParseCompose(cfgs []composetypes.ConfigFile, envs map[string]string) (*Conf
c.Groups = append(c.Groups, g)
}

if xbakeSet {
logrus.Warn("x-bake extension is deprecated and will be removed in a future release, use the official specification instead: https://docs.docker.com/reference/compose-file/build/")
}

return &c, nil
}

Expand Down Expand Up @@ -332,17 +340,17 @@ func (sa *stringArray) UnmarshalYAML(unmarshal func(interface{}) error) error {

// composeExtTarget converts Compose build extension x-bake to bake Target
// https://github.com/compose-spec/compose-spec/blob/master/spec.md#extension
func (t *Target) composeExtTarget(exts map[string]interface{}) error {
func (t *Target) composeExtTarget(exts map[string]interface{}) (bool, error) {
var xb xbake

ext, ok := exts["x-bake"]
if !ok || ext == nil {
return nil
return false, nil
}

yb, _ := yaml.Marshal(ext)
if err := yaml.Unmarshal(yb, &xb); err != nil {
return err
return false, err
}

if len(xb.Tags) > 0 {
Expand All @@ -351,28 +359,28 @@ func (t *Target) composeExtTarget(exts map[string]interface{}) error {
if len(xb.CacheFrom) > 0 {
cacheFrom, err := buildflags.ParseCacheEntry(xb.CacheFrom)
if err != nil {
return err
return false, err
}
t.CacheFrom = t.CacheFrom.Merge(cacheFrom)
}
if len(xb.CacheTo) > 0 {
cacheTo, err := buildflags.ParseCacheEntry(xb.CacheTo)
if err != nil {
return err
return false, err
}
t.CacheTo = t.CacheTo.Merge(cacheTo)
}
if len(xb.Secrets) > 0 {
secrets, err := parseArrValue[buildflags.Secret](xb.Secrets)
if err != nil {
return err
return false, err
}
t.Secrets = t.Secrets.Merge(secrets)
}
if len(xb.SSH) > 0 {
ssh, err := parseArrValue[buildflags.SSH](xb.SSH)
if err != nil {
return err
return false, err
}
t.SSH = t.SSH.Merge(ssh)
slices.SortFunc(t.SSH, func(a, b *buildflags.SSH) int {
Expand All @@ -385,7 +393,7 @@ func (t *Target) composeExtTarget(exts map[string]interface{}) error {
if len(xb.Outputs) > 0 {
outputs, err := parseArrValue[buildflags.ExportEntry](xb.Outputs)
if err != nil {
return err
return false, err
}
t.Outputs = t.Outputs.Merge(outputs)
}
Expand All @@ -402,7 +410,7 @@ func (t *Target) composeExtTarget(exts map[string]interface{}) error {
t.Contexts = dedupMap(t.Contexts, xb.Contexts)
}

return nil
return true, nil
}

// composeToBuildkitSecret converts secret from compose format to buildkit's
Expand Down
Loading