mirror of
https://github.com/docker/cli.git
synced 2026-11-06 13:10:41 -04:00
Paweł Gronowski
b1f2c1dc06
Plugins had no generic way to declare support for optional CLI contracts, so each one would need its own top-level metadata field. Add Features, keyed by feature name. Values are arbitrary JSON so a feature can carry more than a boolean. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
45 lines
1.7 KiB
Go
45 lines
1.7 KiB
Go
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
|
//go:build go1.26
|
|
|
|
package metadata
|
|
|
|
const (
|
|
// NamePrefix is the prefix required on all plugin binary names
|
|
NamePrefix = "docker-"
|
|
|
|
// MetadataSubcommandName is the name of the plugin subcommand
|
|
// which must be supported by every plugin and returns the
|
|
// plugin metadata.
|
|
MetadataSubcommandName = "docker-cli-plugin-metadata"
|
|
|
|
// HookSubcommandName is the name of the plugin subcommand
|
|
// which must be implemented by plugins declaring support
|
|
// for hooks in their metadata.
|
|
HookSubcommandName = "docker-cli-plugin-hooks"
|
|
|
|
// ReexecEnvvar is the name of an ennvar which is set to the command
|
|
// used to originally invoke the docker CLI when executing a
|
|
// plugin. Assuming $PATH and $CWD remain unchanged this should allow
|
|
// the plugin to re-execute the original CLI.
|
|
ReexecEnvvar = "DOCKER_CLI_PLUGIN_ORIGINAL_CLI_COMMAND"
|
|
)
|
|
|
|
// Metadata provided by the plugin.
|
|
type Metadata struct {
|
|
// SchemaVersion describes the version of this struct. Mandatory, must be "0.1.0"
|
|
SchemaVersion string `json:",omitempty"`
|
|
// Vendor is the name of the plugin vendor. Mandatory
|
|
Vendor string `json:",omitempty"`
|
|
// Version is the optional version of this plugin.
|
|
Version string `json:",omitempty"`
|
|
// ShortDescription should be suitable for a single line help message.
|
|
ShortDescription string `json:",omitempty"`
|
|
// URL is a pointer to the plugin's homepage.
|
|
URL string `json:",omitempty"`
|
|
// Hidden hides the plugin in completion and help message output.
|
|
Hidden bool `json:",omitempty"`
|
|
// Features declares optional contracts supported by the plugin, keyed by
|
|
// feature name.
|
|
Features map[string]any `json:",omitempty"`
|
|
}
|