Add buildx history command #2891

tonistiigi · 2025-01-07T05:42:31Z

implements #2711

These commands allow working with build records
of completed and running builds.

Currently supports:

history ls
history logs
history rm
history open
history inspect
history inspect attachment

docs/reference/buildx_history_rm.md

docs/reference/buildx.md

crazy-max · 2025-01-07T15:26:30Z

commands/history/utils.go

+	"golang.org/x/sync/errgroup"
+)
+
+func buildName(fattrs map[string]string, ls *localstate.State) string {


We are using the same logic in Docker Desktop. Could we make this one public and use it in DD?

This isn't directly the same because the types are different, so I think it can be figured out in follow-up.

crazy-max · 2025-01-07T15:31:18Z

commands/history/ls.go

+	if c.format.IsTable() {
+		if c.isTerm {
+			return desktop.ANSIHyperlink(url, "Open")
+		}
+		return ""
+	}


Was going to comment about the table that could be quite huge with the link but with this hyperlink this looks great.

commands/history/ls.go

dvdksn · 2025-01-09T10:47:42Z

commands/history/open.go

There's now also a docker desktop CLI plugin. I think it would make more sense to put this feature in there, e.g. docker desktop open build <id>. WDYT?

crazy-max · 2025-01-09T15:44:15Z

commands/history/ls.go

+	lsHeaderDuration = "DURATION"
+	lsHeaderLink     = ""
+
+	lsDefaultTableFormat = "table {{.Ref}}\t{{.Name}}\t{{.Status}}\t{{.CreatedAt}}\t{{.Duration}}\t{{.Link}}"


Could we have a builder column? At first sight I'm not sure what builder is used:

$ docker buildx history ls BUILD ID NAME STATUS CREATED AT DURATION 6kfisaus77v2lng6uh013mqsg buildx (binaries) Completed About a minute ago 47.9s Open i2bwu6bu90hsgrcwt8ino4pdv ..ckerfiles/docs.Dockerfile (update) Completed 5 hours ago 1m 1s Open l75hmymzlopcthlmp1onrko60 buildx (binaries) Completed 5 hours ago 1m 0s Open 2dujhidv8awc8b931fx27ok0l ..ckerfiles/docs.Dockerfile (update) Completed 5 hours ago 38.4s Open ohcjje6ufqa2q1y025yroxs45 ..ckerfiles/docs.Dockerfile (update) Error 5 hours ago 47.3s Open 2cd0dp6aez14aort5yqv0qt0s ..ckerfiles/docs.Dockerfile (update) Completed 5 hours ago 1m 0s Open sbdkqcz8pnpgk5o8hpep7efml buildx (binaries) Completed 5 hours ago 56.4s Open 1383761vlyc7v5zpvnu04x969 buildx (binaries) Completed 5 hours ago 58.2s Open usjztin7bie33n53748tme8uw buildx (binaries) Completed 6 hours ago 1m 17s Open w6eq2yd1fp000sgcstdwb5kq2 ..ckerfiles/docs.Dockerfile (update) Completed 8 hours ago 53.8s Open tn6je06lbx11w5446qk2mijil ..ckerfiles/docs.Dockerfile (update) Error 8 hours ago 46.7s Open zlzmiimgbujyoxrexg193j5mm buildx (binaries) Completed 29 hours ago 1m 12s Open lapq0qhot3rt889b9zgfz6p3b buildx (binaries) Error 29 hours ago 53.4s Open e65kwe3vw61fhzruia0qqd6vw ..ion/dev.Dockerfile (format-update) Completed 30 hours ago 25.9s Open w6kji8z2tutykbad1dykdvo4j ..tion/dev.Dockerfile (build-update) Completed 30 hours ago 34.2s Open 39p6gvyf0bt1l3lnpr1wmicsl ..ion/dev.Dockerfile (vendor-update) Completed 30 hours ago 22.4s Open qbgt47jlt98e34in2skv88d1m ..ion/dev.Dockerfile (format-update) Completed 30 hours ago 25.2s Open 0pxk73dru42im1cc6seee9k5o ..ion/dev.Dockerfile (vendor-update) Completed 30 hours ago 20.4s Open

But they all have the same builder

True but I was thinking of smth similar to what we have done when building #1177 to have a hint of what builder it's coming from

crazy-max · 2025-01-09T15:46:49Z

commands/history/inspect.go

+	if _, ok := attrs["context"]; !ok {
+		if src, ok := attrs["vcs:source"]; ok {
+			fmt.Fprintf(tw, "VCS Repository:\t%s\n", src)
+		}
+		if rev, ok := attrs["vcs:revision"]; ok {
+			fmt.Fprintf(tw, "VCS Revision:\t%s\n", rev)
+		}
+	}


I think we could keep the well-known git context format like:

VCS: https://github.com/tonistiigi/buildx#dfdd89d50e60af52129a88b47792c9784470f708

instead of:

VCS Repository: https://github.com/tonistiigi/buildx VCS Revision: dfdd89d50e60af52129a88b47792c9784470f708

commands/history/inspect.go

These commands allow working with build records of completed and running builds. Signed-off-by: Tonis Tiigi <[email protected]>

Signed-off-by: Tonis Tiigi <[email protected]>

tonistiigi · 2025-01-10T06:11:59Z

Updated with completion of inspect and inspect attachment commands. Trace command has been separated to #2904 .

Signed-off-by: Tonis Tiigi <[email protected]>

crazy-max · 2025-01-10T13:25:05Z

commands/history/inspect.go

+	if len(attachments) > 0 {
+		fmt.Fprintf(tw, "Attachments:\n")
+		tw = tabwriter.NewWriter(dockerCli.Out(), 1, 8, 1, '\t', 0)
+		fmt.Fprintf(tw, "DIGEST\tPLATFORM\tTYPE\n")
+		for _, a := range attachments {
+			p := ""
+			if a.platform != nil {
+				p = platforms.FormatAll(*a.platform)
+			}
+			fmt.Fprintf(tw, "%s\t%s\t%s\n", a.descr.Digest, p, descrType(a.descr))
+		}
+		tw.Flush()
+		fmt.Fprintln(dockerCli.Out())
+	}


Nice this is what I was looking for on my side

crazy-max

LGTM for this first iteration

As follow-up:

inspect format with JSON output so we can use this command for build summmary in GHA and get rid of export-build container.
- Or I could use ls JSON output but needs the build error: https://github.com/docker/actions-toolkit/blob/54bdcf6c08a9b43d37df4156506648c978b372fe/src/github.ts#L283-L299
make buildName public
WDYT about Add buildx history command #2891 (comment)?

tonistiigi · 2025-01-10T16:26:03Z

WDYT about #2891 (comment)?

#2891 (comment)

tonistiigi added this to the v0.20.0 milestone Jan 7, 2025

github-actions bot added area/cli area/docs area/dependencies labels Jan 7, 2025

tonistiigi mentioned this pull request Jan 7, 2025

Proposal: buildx history command #2711

Open

tonistiigi force-pushed the history-command-initial branch from ef6b9ce to 14a1153 Compare January 7, 2025 06:12

crazy-max reviewed Jan 7, 2025

View reviewed changes

tonistiigi force-pushed the history-command-initial branch 2 times, most recently from 1f03cd2 to dfdd89d Compare January 8, 2025 05:27

dvdksn reviewed Jan 9, 2025

View reviewed changes

crazy-max reviewed Jan 9, 2025

View reviewed changes

commands/history/inspect.go Show resolved Hide resolved

tonistiigi added 3 commits January 9, 2025 21:53

Add buildx history command

7c8c33b

These commands allow working with build records of completed and running builds. Signed-off-by: Tonis Tiigi <[email protected]>

add buildx history inspect formatting

cdc36e3

Signed-off-by: Tonis Tiigi <[email protected]>

update history inspect formatting

18e8e55

Signed-off-by: Tonis Tiigi <[email protected]>

tonistiigi mentioned this pull request Jan 10, 2025

Add history trace command #2904

Draft

tonistiigi force-pushed the history-command-initial branch from dfdd89d to 12180f2 Compare January 10, 2025 06:10

tonistiigi marked this pull request as ready for review January 10, 2025 06:10

add history inspect attachment command

6489c8f

Signed-off-by: Tonis Tiigi <[email protected]>

tonistiigi force-pushed the history-command-initial branch from 12180f2 to 6489c8f Compare January 10, 2025 07:10

crazy-max reviewed Jan 10, 2025

View reviewed changes

crazy-max approved these changes Jan 10, 2025

View reviewed changes

crazy-max added the status/needs-follow-up label Jan 13, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add buildx history command #2891

Add buildx history command #2891

tonistiigi commented Jan 7, 2025 •

edited

Loading

crazy-max Jan 7, 2025

tonistiigi Jan 7, 2025

crazy-max Jan 7, 2025

dvdksn Jan 9, 2025

crazy-max Jan 9, 2025

tonistiigi Jan 9, 2025

crazy-max Jan 9, 2025 •

edited

Loading

crazy-max Jan 9, 2025

tonistiigi commented Jan 10, 2025

crazy-max Jan 10, 2025

crazy-max left a comment •

edited

Loading

tonistiigi commented Jan 10, 2025

Add buildx history command #2891

Are you sure you want to change the base?

Add buildx history command #2891

Conversation

tonistiigi commented Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crazy-max Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonistiigi commented Jan 10, 2025

Choose a reason for hiding this comment

crazy-max left a comment • edited Loading

Choose a reason for hiding this comment

tonistiigi commented Jan 10, 2025

tonistiigi commented Jan 7, 2025 •

edited

Loading

crazy-max Jan 9, 2025 •

edited

Loading

crazy-max left a comment •

edited

Loading