Skip to content

Commit bb7dbaa

Browse files
committed
api/types: move BuildResult to api/types/build.Result
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 4b9f070 commit bb7dbaa

8 files changed

Lines changed: 26 additions & 18 deletions

File tree

api/server/backend/build/backend.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,30 +60,30 @@ func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string
6060
return "", err
6161
}
6262

63-
var build *builder.Result
63+
var buildResult *builder.Result
6464
if useBuildKit {
65-
build, err = b.buildkit.Build(ctx, config)
65+
buildResult, err = b.buildkit.Build(ctx, config)
6666
if err != nil {
6767
return "", err
6868
}
6969
} else {
70-
build, err = b.builder.Build(ctx, config)
70+
buildResult, err = b.builder.Build(ctx, config)
7171
if err != nil {
7272
return "", err
7373
}
7474
}
7575

76-
if build == nil {
76+
if buildResult == nil {
7777
return "", nil
7878
}
7979

80-
imageID := build.ImageID
80+
imageID := buildResult.ImageID
8181
if options.Squash {
82-
if imageID, err = squashBuild(build, b.imageComponent); err != nil {
82+
if imageID, err = squashBuild(buildResult, b.imageComponent); err != nil {
8383
return "", err
8484
}
8585
if config.ProgressWriter.AuxFormatter != nil {
86-
if err = config.ProgressWriter.AuxFormatter.Emit("moby.image.id", types.BuildResult{ID: imageID}); err != nil {
86+
if err = config.ProgressWriter.AuxFormatter.Emit("moby.image.id", build.Result{ID: imageID}); err != nil {
8787
return "", err
8888
}
8989
}

api/types/build/build.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package build
2+
3+
// Result contains the image id of a successful build.
4+
type Result struct {
5+
ID string
6+
}

api/types/types.go

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,3 @@ type PushResult struct {
126126
Digest string
127127
Size int
128128
}
129-
130-
// BuildResult contains the image id of a successful build
131-
type BuildResult struct {
132-
ID string
133-
}

api/types/types_deprecated.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,8 @@ type BuildCachePruneOptions = build.CachePruneOptions
130130
//
131131
// Deprecated: use [build.CachePruneReport].
132132
type BuildCachePruneReport = build.CachePruneReport
133+
134+
// BuildResult contains the image id of a successful build/
135+
//
136+
// Deprecated: use [build.Result].
137+
type BuildResult = build.Result

builder/builder-next/builder.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import (
1212

1313
"github.com/containerd/containerd/v2/core/remotes/docker"
1414
"github.com/containerd/platforms"
15-
"github.com/docker/docker/api/types"
1615
"github.com/docker/docker/api/types/backend"
1716
"github.com/docker/docker/api/types/build"
1817
"github.com/docker/docker/api/types/container"
@@ -438,7 +437,7 @@ func (b *Builder) Build(ctx context.Context, opt backend.BuildConfig) (*builder.
438437
return errors.Errorf("missing image id")
439438
}
440439
out.ImageID = imgID
441-
return aux.Emit("moby.image.id", types.BuildResult{ID: imgID})
440+
return aux.Emit("moby.image.id", build.Result{ID: imgID})
442441
})
443442

444443
ch := make(chan *controlapi.StatusResponse)

builder/dockerfile/builder.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/containerd/platforms"
1313
"github.com/docker/docker/api/types"
1414
"github.com/docker/docker/api/types/backend"
15+
"github.com/docker/docker/api/types/build"
1516
"github.com/docker/docker/api/types/container"
1617
"github.com/docker/docker/builder"
1718
"github.com/docker/docker/builder/remotecontext"
@@ -222,7 +223,7 @@ func emitImageID(aux *streamformatter.AuxFormatter, state *dispatchState) error
222223
if aux == nil || state.imageID == "" {
223224
return nil
224225
}
225-
return aux.Emit("", types.BuildResult{ID: state.imageID})
226+
return aux.Emit("", build.Result{ID: state.imageID})
226227
}
227228

228229
func processMetaArg(meta instructions.ArgCommand, shlex *shell.Lex, args *BuildArgs) error {

integration/container/copy_test.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"testing"
1313

1414
"github.com/docker/docker/api/types"
15+
"github.com/docker/docker/api/types/build"
1516
containertypes "github.com/docker/docker/api/types/container"
1617
"github.com/docker/docker/errdefs"
1718
"github.com/docker/docker/integration/internal/container"
@@ -200,7 +201,7 @@ func makeTestImage(ctx context.Context, t *testing.T) (imageID string) {
200201
defer resp.Body.Close()
201202

202203
err = jsonmessage.DisplayJSONMessagesStream(resp.Body, io.Discard, 0, false, func(msg jsonmessage.JSONMessage) {
203-
var r types.BuildResult
204+
var r build.Result
204205
assert.NilError(t, json.Unmarshal(*msg.Aux, &r))
205206
imageID = r.ID
206207
})
@@ -275,7 +276,7 @@ func TestCopyFromContainer(t *testing.T) {
275276

276277
var imageID string
277278
err = jsonmessage.DisplayJSONMessagesStream(resp.Body, io.Discard, 0, false, func(msg jsonmessage.JSONMessage) {
278-
var r types.BuildResult
279+
var r build.Result
279280
assert.NilError(t, json.Unmarshal(*msg.Aux, &r))
280281
imageID = r.ID
281282
})

integration/internal/build/build.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import (
77
"testing"
88

99
"github.com/docker/docker/api/types"
10+
"github.com/docker/docker/api/types/build"
1011
"github.com/docker/docker/api/types/image"
1112
"github.com/docker/docker/client"
1213
"github.com/docker/docker/pkg/jsonmessage"
@@ -32,7 +33,7 @@ func Do(ctx context.Context, t *testing.T, client client.APIClient, buildCtx *fa
3233
func GetImageIDFromBody(t *testing.T, body io.Reader) string {
3334
var (
3435
jm jsonmessage.JSONMessage
35-
br types.BuildResult
36+
br build.Result
3637
dec = json.NewDecoder(body)
3738
)
3839
for {

0 commit comments

Comments
 (0)