From 191e86de724c37fbffc1156603b3e499cef79fbb Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sat, 11 Sep 2021 20:43:15 +0200 Subject: [PATCH] improve usage texts --- cmd/drone-docker-buildx/config.go | 74 +++++++++++++++---------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/cmd/drone-docker-buildx/config.go b/cmd/drone-docker-buildx/config.go index 3e51ac7..7d8b941 100644 --- a/cmd/drone-docker-buildx/config.go +++ b/cmd/drone-docker-buildx/config.go @@ -11,112 +11,112 @@ func settingsFlags(settings *plugin.Settings) []cli.Flag { &cli.BoolFlag{ Name: "dry-run", EnvVars: []string{"PLUGIN_DRY_RUN"}, - Usage: "dry run disables docker push", + Usage: "disables docker push", Destination: &settings.Dryrun, }, &cli.StringFlag{ Name: "remote.url", EnvVars: []string{"DRONE_REMOTE_URL"}, - Usage: "git remote url", + Usage: "sets the git remote url", Destination: &settings.Build.Remote, }, &cli.StringFlag{ Name: "daemon.mirror", EnvVars: []string{"PLUGIN_MIRROR", "DOCKER_PLUGIN_MIRROR"}, - Usage: "docker daemon registry mirror", + Usage: "sets a registry mirror to pull images", Destination: &settings.Daemon.Mirror, }, &cli.StringFlag{ Name: "daemon.storage-driver", EnvVars: []string{"PLUGIN_STORAGE_DRIVER"}, - Usage: "docker daemon storage driver", + Usage: "sets the docker daemon storage driver", Destination: &settings.Daemon.StorageDriver, }, &cli.StringFlag{ Name: "daemon.storage-path", EnvVars: []string{"PLUGIN_STORAGE_PATH"}, - Usage: "docker daemon storage path", + Usage: "sets the docker daemon storage path", Value: "/var/lib/docker", Destination: &settings.Daemon.StoragePath, }, &cli.StringFlag{ Name: "daemon.bip", EnvVars: []string{"PLUGIN_BIP"}, - Usage: "docker daemon bride ip address", + Usage: "allows the docker daemon to bride ip address", Destination: &settings.Daemon.Bip, }, &cli.StringFlag{ Name: "daemon.mtu", EnvVars: []string{"PLUGIN_MTU"}, - Usage: "docker daemon custom mtu setting", + Usage: "sets docker daemon custom mtu setting", Destination: &settings.Daemon.MTU, }, &cli.StringSliceFlag{ Name: "daemon.dns", EnvVars: []string{"PLUGIN_CUSTOM_DNS"}, - Usage: "docker daemon dns server", + Usage: "sets custom docker daemon dns server", Destination: &settings.Daemon.DNS, }, &cli.StringSliceFlag{ Name: "daemon.dns-search", EnvVars: []string{"PLUGIN_CUSTOM_DNS_SEARCH"}, - Usage: "docker daemon dns search domains", + Usage: "sets custom docker daemon dns search domain", Destination: &settings.Daemon.DNSSearch, }, &cli.BoolFlag{ Name: "daemon.insecure", EnvVars: []string{"PLUGIN_INSECURE"}, - Usage: "docker daemon allows insecure registries", + Usage: "allows the docker daemon to use insecure registries", Destination: &settings.Daemon.Insecure, }, &cli.BoolFlag{ Name: "daemon.ipv6", EnvVars: []string{"PLUGIN_IPV6"}, - Usage: "docker daemon IPv6 networking", + Usage: "enables docker daemon IPv6 support", Destination: &settings.Daemon.IPv6, }, &cli.BoolFlag{ Name: "daemon.experimental", EnvVars: []string{"PLUGIN_EXPERIMENTAL"}, - Usage: "docker daemon Experimental mode", + Usage: "enables docker daemon experimental mode", Destination: &settings.Daemon.Experimental, }, &cli.BoolFlag{ Name: "daemon.debug", EnvVars: []string{"PLUGIN_DEBUG", "DOCKER_LAUNCH_DEBUG"}, - Usage: "docker daemon executes in debug mode", + Usage: "enables verbose debug mode for the docker daemon", Destination: &settings.Daemon.Debug, }, &cli.BoolFlag{ Name: "daemon.off", EnvVars: []string{"PLUGIN_DAEMON_OFF"}, - Usage: "don't start the docker daemon", + Usage: "disables the startup of the docker daemon", Destination: &settings.Daemon.Disabled, }, &cli.StringFlag{ Name: "daemon.buildkit-config", EnvVars: []string{"PLUGIN_BUILDKIT_CONFIG"}, - Usage: "docker buildkit json config content", + Usage: "sets content of the docker buildkit json config", Destination: &settings.Daemon.BuildkitConfig, }, &cli.StringFlag{ Name: "dockerfile", EnvVars: []string{"PLUGIN_DOCKERFILE"}, - Usage: "build dockerfile", + Usage: "sets dockerfile to use for the image build", Value: "Dockerfile", Destination: &settings.Build.Dockerfile, }, &cli.StringFlag{ Name: "context", EnvVars: []string{"PLUGIN_CONTEXT"}, - Usage: "build context", + Usage: "sets the path of the build context to use", Value: ".", Destination: &settings.Build.Context, }, &cli.StringSliceFlag{ Name: "tags", EnvVars: []string{"PLUGIN_TAG", "PLUGIN_TAGS"}, - Usage: "build tags", + Usage: "sets repository tags to use for the image", Value: cli.NewStringSlice([]string{"latest"}...), FilePath: ".tags", Destination: &settings.Build.Tags, @@ -124,118 +124,118 @@ func settingsFlags(settings *plugin.Settings) []cli.Flag { &cli.BoolFlag{ Name: "tags.auto", EnvVars: []string{"PLUGIN_DEFAULT_TAGS", "PLUGIN_AUTO_TAG"}, - Usage: "default build tags", + Usage: "generates tag names automatically based on git branch and git tag", Destination: &settings.Build.TagsAuto, }, &cli.StringFlag{ Name: "tags.suffix", EnvVars: []string{"PLUGIN_DEFAULT_SUFFIX", "PLUGIN_AUTO_TAG_SUFFIX"}, - Usage: "default build tags with suffix", + Usage: "generates tag names with the given suffix", Destination: &settings.Build.TagsSuffix, }, &cli.StringSliceFlag{ Name: "args", EnvVars: []string{"PLUGIN_BUILD_ARGS"}, - Usage: "build args", + Usage: "sets custom build arguments for the build", Destination: &settings.Build.Args, }, &cli.StringSliceFlag{ Name: "args-from-env", EnvVars: []string{"PLUGIN_BUILD_ARGS_FROM_ENV"}, - Usage: "build args", + Usage: "forwards environment variables as custom arguments to the build", Destination: &settings.Build.ArgsEnv, }, &cli.BoolFlag{ Name: "quiet", EnvVars: []string{"PLUGIN_QUIET"}, - Usage: "quiet docker build", + Usage: "enables suppression of the build output", Destination: &settings.Build.Quiet, }, &cli.StringFlag{ Name: "target", EnvVars: []string{"PLUGIN_TARGET"}, - Usage: "build target", + Usage: "sets the build target to use", Destination: &settings.Build.Target, }, &cli.StringSliceFlag{ Name: "cache-from", EnvVars: []string{"PLUGIN_CACHE_FROM"}, - Usage: "images to consider as cache sources", + Usage: "sets images to consider as cache sources", Destination: &settings.Build.CacheFrom, }, &cli.BoolFlag{ Name: "pull-image", EnvVars: []string{"PLUGIN_PULL_IMAGE"}, - Usage: "force pull base image at build time", + Usage: "enforces to pull base image at build time", Value: true, Destination: &settings.Build.Pull, }, &cli.BoolFlag{ Name: "compress", EnvVars: []string{"PLUGIN_COMPRESS"}, - Usage: "compress the build context using gzip", + Usage: "enables compression og the build context using gzip", Destination: &settings.Build.Compress, }, &cli.StringFlag{ Name: "repo", EnvVars: []string{"PLUGIN_REPO"}, - Usage: "docker repository", + Usage: "sets repository name for the image", Destination: &settings.Build.Repo, }, &cli.StringFlag{ Name: "docker.registry", EnvVars: []string{"PLUGIN_REGISTRY", "DOCKER_REGISTRY"}, - Usage: "docker registry", + Usage: "sets docker registry to authenticate with", Value: "https://index.docker.io/v1/", Destination: &settings.Login.Registry, }, &cli.StringFlag{ Name: "docker.username", EnvVars: []string{"PLUGIN_USERNAME", "DOCKER_USERNAME"}, - Usage: "docker username", + Usage: "sets username to authenticates with", Destination: &settings.Login.Username, }, &cli.StringFlag{ Name: "docker.password", EnvVars: []string{"PLUGIN_PASSWORD", "DOCKER_PASSWORD"}, - Usage: "docker password", + Usage: "sets password to authenticates with", Destination: &settings.Login.Password, }, &cli.StringFlag{ Name: "docker.email", EnvVars: []string{"PLUGIN_EMAIL", "DOCKER_EMAIL"}, - Usage: "docker email", + Usage: "sets email addres to authenticates with", Destination: &settings.Login.Email, }, &cli.StringFlag{ Name: "docker.config", EnvVars: []string{"PLUGIN_CONFIG", "DOCKER_PLUGIN_CONFIG"}, - Usage: "docker json dockerconfig content", + Usage: "sets content of the docker daemon json config", Destination: &settings.Login.Config, }, &cli.BoolFlag{ Name: "docker.purge", EnvVars: []string{"PLUGIN_PURGE"}, - Usage: "docker should cleanup images", + Usage: "enables cleanup of the docker environment at the end of a build", Value: true, Destination: &settings.Cleanup, }, &cli.BoolFlag{ Name: "no-cache", EnvVars: []string{"PLUGIN_NO_CACHE"}, - Usage: "do not use cached intermediate containers", + Usage: "disables the usage of cached intermediate containers", Destination: &settings.Build.NoCache, }, &cli.StringSliceFlag{ Name: "add-host", EnvVars: []string{"PLUGIN_ADD_HOST"}, - Usage: "additional host:IP mapping", + Usage: "sets additional host:ip mapping", Destination: &settings.Build.AddHost, }, &cli.StringSliceFlag{ Name: "platforms", EnvVars: []string{"PLUGIN_PLATFORMS"}, - Usage: "arget platform for build", + Usage: "sets target platform for build", Destination: &settings.Build.Platforms, }, }