Merge pull request #323 from depot/billy/feat/custom-tags

feat: add support for custom save tags

Author: jacobwgillespie

pkg/buildx/commands/bake.go

@@ -203,7 +203,7 @@ func RunBake(dockerCli command.Cli, in BakeOptions, validator BakeValidator, pri
 	_ = printer.Wait()
 
 	if in.save {
-		printSaveHelp(in.project, in.buildID, in.progress, requestedTargets)
+		printSaveHelp(in.project, in.buildID, in.progress, requestedTargets, in.additionalTags)
 	}
 	linter.Print(os.Stderr, in.progress)
 	return nil
@@ -295,10 +295,11 @@ func BakeCmd() *cobra.Command {
 					options.project,
 					bakeOpts,
 					helpers.UsingDepotFeatures{
-						Push: options.exportPush,
-						Load: options.exportLoad,
-						Save: options.save,
-						Lint: options.lint,
+						Push:     options.exportPush,
+						Load:     options.exportLoad,
+						Save:     options.save,
+						SaveTags: options.saveTags,
+						Lint:     options.lint,
 					},
 				)
 				build, err := helpers.BeginBuild(context.Background(), req, token)
@@ -557,7 +558,7 @@ func parseBakeTargets(targets []string) (bkt bakeTargets) {
 }
 
 // printSaveHelp prints instructions to pull or push the saved targets.
-func printSaveHelp(project, buildID, progressMode string, requestedTargets []string) {
+func printSaveHelp(project, buildID, progressMode string, requestedTargets, additionalTags []string) {
 	if progressMode != progress.PrinterModeQuiet {
 		fmt.Fprintln(os.Stderr)
 		saved := "target"
@@ -573,6 +574,47 @@ func printSaveHelp(project, buildID, progressMode string, requestedTargets []str
 		targets := strings.Join(requestedTargets, ",")
 		fmt.Fprintf(os.Stderr, "Saved %s: %s\n", saved, targets)
 		fmt.Fprintf(os.Stderr, "\tTo pull: depot pull --project %s %s\n", project, buildID)
+
+		if len(additionalTags) > 1 {
+			fmt.Fprintf(os.Stderr, "\tTo pull save-tags:\n")
+			fmt.Fprintf(os.Stderr, "\t\tdocker login registry.depot.dev -u x-token -p $(depot pull-token)\n")
+			fmt.Fprintln(os.Stderr)
+
+			// the api will send multiple of the same tag back for each target
+			if len(requestedTargets) > 0 {
+				seenTags := map[string]struct{}{}
+				for _, target := range requestedTargets {
+					if target == "default" {
+						continue
+					}
+
+					for _, tag := range additionalTags {
+						if strings.Contains(tag, buildID) {
+							continue
+						}
+
+						trueTag := tag + "-" + target
+						if _, ok := seenTags[trueTag]; ok {
+							continue
+						}
+						seenTags[trueTag] = struct{}{}
+
+						fmt.Fprintf(os.Stderr, "\t\tdocker pull %s\n", trueTag)
+					}
+				}
+			} else {
+				for _, tag := range additionalTags {
+					if strings.Contains(tag, buildID) {
+						continue
+					}
+
+					fmt.Fprintf(os.Stderr, "\t\tdocker pull %s\n", tag)
+				}
+			}
+
+			fmt.Fprintln(os.Stderr)
+		}
+
 		fmt.Fprintf(os.Stderr, "\tTo push: depot push %s--project %s --tag <REPOSITORY:TAG> %s\n", targetUsage, project, buildID)
 	}
 }

pkg/buildx/commands/build.go

@@ -120,6 +120,7 @@ type DepotOptions struct {
 	build         *depotbuild.Build
 
 	save                  bool
+	saveTags              []string
 	additionalTags        []string
 	additionalCredentials []depotbuild.Credential
 
@@ -353,7 +354,7 @@ func buildTargets(ctx context.Context, dockerCli command.Cli, nodes []builder.No
 
 	printWarnings(os.Stderr, printer.Warnings(), progressMode)
 	if depotOpts.save {
-		printSaveHelp(depotOpts.project, depotOpts.buildID, progressMode, nil)
+		printSaveHelp(depotOpts.project, depotOpts.buildID, progressMode, nil, depotOpts.additionalTags)
 	}
 	linter.Print(os.Stderr, progressMode)
 
@@ -647,10 +648,11 @@ func BuildCmd() *cobra.Command {
 				options.project,
 				validatedOpts,
 				helpers.UsingDepotFeatures{
-					Push: options.exportPush,
-					Load: options.exportLoad,
-					Save: options.save,
-					Lint: options.lint,
+					Push:     options.exportPush,
+					Load:     options.exportLoad,
+					Save:     options.save,
+					SaveTags: options.saveTags,
+					Lint:     options.lint,
 				},
 			)
 
@@ -867,6 +869,7 @@ func depotAttestationFlags(_ *cobra.Command, options *DepotOptions, flags *pflag
 
 func depotRegistryFlags(_ *cobra.Command, options *DepotOptions, flags *pflag.FlagSet) {
 	flags.BoolVar(&options.save, "save", false, `Saves the build to the depot registry`)
+	flags.StringArrayVar(&options.saveTags, "save-tag", []string{}, `Additional custom tag for the saved image, use with --save`)
 }
 
 func checkWarnedFlags(f *pflag.Flag) {

pkg/helpers/build.go

@@ -39,10 +39,11 @@ func BeginBuild(ctx context.Context, req *cliv1.CreateBuildRequest, token string
 }
 
 type UsingDepotFeatures struct {
-	Push bool
-	Load bool
-	Save bool
-	Lint bool
+	Push     bool
+	Load     bool
+	Save     bool
+	SaveTags []string
+	Lint     bool
 }
 
 func NewBuildRequest(project string, opts map[string]buildx.Options, features UsingDepotFeatures) *cliv1.CreateBuildRequest {
@@ -67,6 +68,7 @@ func NewBuildRequest(project string, opts map[string]buildx.Options, features Us
 				{
 					Command:    cliv1.Command_COMMAND_BUILD,
 					Tags:       opts.Tags,
+					SaveTags:   features.SaveTags,
 					Outputs:    outputs,
 					Push:       features.Push,
 					Load:       features.Load,
@@ -84,8 +86,8 @@ func NewBuildRequest(project string, opts map[string]buildx.Options, features Us
 func NewBakeRequest(project string, opts map[string]buildx.Options, features UsingDepotFeatures) *cliv1.CreateBuildRequest {
 	targets := make([]*cliv1.BuildOptions, 0, len(opts))
 
-	for name, opts := range opts {
-		name := name
+	for targetName, opts := range opts {
+		targetName := targetName
 		outputs := make([]*cliv1.BuildOutput, len(opts.Exports))
 		for i := range opts.Exports {
 			outputs[i] = &cliv1.BuildOutput{
@@ -102,7 +104,8 @@ func NewBakeRequest(project string, opts map[string]buildx.Options, features Usi
 			Load:       features.Load,
 			Save:       features.Save,
 			Lint:       features.Lint,
-			TargetName: &name,
+			SaveTags:   features.SaveTags,
+			TargetName: &targetName,
 		})
 	}