mirror of
https://github.com/docker/buildx.git
synced 2024-11-22 15:37:16 +08:00
02c2073feb
Prior to this commit, experimental flags were not distinguishable from regular flags in `--help` Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
116 lines
2.8 KiB
Go
116 lines
2.8 KiB
Go
package main
|
|
|
|
import (
|
|
"log"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/docker/buildx/commands"
|
|
clidocstool "github.com/docker/cli-docs-tool"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
|
|
// import drivers otherwise factories are empty
|
|
// for --driver output flag usage
|
|
_ "github.com/docker/buildx/driver/docker"
|
|
_ "github.com/docker/buildx/driver/docker-container"
|
|
_ "github.com/docker/buildx/driver/kubernetes"
|
|
_ "github.com/docker/buildx/driver/remote"
|
|
)
|
|
|
|
const defaultSourcePath = "docs/reference/"
|
|
|
|
type options struct {
|
|
source string
|
|
formats []string
|
|
}
|
|
|
|
// fixUpExperimentalCLI trims the " (EXPERIMENTAL)" suffix from the CLI output,
|
|
// as docs.docker.com already displays "experimental (CLI)",
|
|
//
|
|
// https://github.com/docker/buildx/pull/2188#issuecomment-1889487022
|
|
func fixUpExperimentalCLI(cmd *cobra.Command) {
|
|
const (
|
|
annotationExperimentalCLI = "experimentalCLI"
|
|
suffixExperimental = " (EXPERIMENTAL)"
|
|
)
|
|
if _, ok := cmd.Annotations[annotationExperimentalCLI]; ok {
|
|
cmd.Short = strings.TrimSuffix(cmd.Short, suffixExperimental)
|
|
}
|
|
cmd.Flags().VisitAll(func(f *pflag.Flag) {
|
|
if _, ok := f.Annotations[annotationExperimentalCLI]; ok {
|
|
f.Usage = strings.TrimSuffix(f.Usage, suffixExperimental)
|
|
}
|
|
})
|
|
for _, c := range cmd.Commands() {
|
|
fixUpExperimentalCLI(c)
|
|
}
|
|
}
|
|
|
|
func gen(opts *options) error {
|
|
log.SetFlags(0)
|
|
|
|
dockerCLI, err := command.NewDockerCli()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cmd := &cobra.Command{
|
|
Use: "docker [OPTIONS] COMMAND [ARG...]",
|
|
Short: "The base command for the Docker CLI.",
|
|
DisableAutoGenTag: true,
|
|
}
|
|
|
|
cmd.AddCommand(commands.NewRootCmd("buildx", true, dockerCLI))
|
|
|
|
c, err := clidocstool.New(clidocstool.Options{
|
|
Root: cmd,
|
|
SourceDir: opts.source,
|
|
Plugin: true,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, format := range opts.formats {
|
|
switch format {
|
|
case "md":
|
|
if err = c.GenMarkdownTree(cmd); err != nil {
|
|
return err
|
|
}
|
|
case "yaml":
|
|
// fix up is needed only for yaml (used for generating docs.docker.com contents)
|
|
fixUpExperimentalCLI(cmd)
|
|
if err = c.GenYamlTree(cmd); err != nil {
|
|
return err
|
|
}
|
|
default:
|
|
return errors.Errorf("unknown format %q", format)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func run() error {
|
|
opts := &options{}
|
|
flags := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError)
|
|
flags.StringVar(&opts.source, "source", defaultSourcePath, "Docs source folder")
|
|
flags.StringSliceVar(&opts.formats, "formats", []string{}, "Format (md, yaml)")
|
|
if err := flags.Parse(os.Args[1:]); err != nil {
|
|
return err
|
|
}
|
|
if len(opts.formats) == 0 {
|
|
return errors.New("Docs format required")
|
|
}
|
|
return gen(opts)
|
|
}
|
|
|
|
func main() {
|
|
if err := run(); err != nil {
|
|
log.Printf("ERROR: %+v", err)
|
|
os.Exit(1)
|
|
}
|
|
}
|