distgotaskprovider

package
v1.103.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 15, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GlobalFlagOptions added in v1.91.0

type GlobalFlagOptions struct {
	DebugFlagName      string `json:"debugFlag"`
	ProjectDirFlagName string `json:"projectDirFlag"`
}

GlobalFlagOptions specifies how the task should interact with global flags. Based on the godel globalFlagOptionsImpl definition at https://github.com/palantir/godel/blob/8537d0ea9067d3bdd36d5db06069b71fde92188b/framework/pluginapi/v2/pluginapi/globalflagopts.go#L34

type TaskInfo

type TaskInfo struct {
	// Name is the name of the task. This is the task/command name registered by the distgo TaskProvider API.
	Name string `json:"name"`

	// Description is the description of the task. It is used as the "Short" description of the task/command.
	Description string `json:"description"`

	// Command specifies the arguments used to invoke the task/command on the asset. In many instances, this may be the
	// same value as Name, but it may be different if the task name for the purposes of the TaskProvider API is
	// different from the command used to invoke the task on the asset.
	Command []string `json:"command"`

	// GlobalFlagOptions specifies the configuration for the global flag options. If any of the fields are non-nil, the
	// global flag value is provided to the task as a flag.
	GlobalFlagOptions GlobalFlagOptions `json:"globalFlagOptions"`

	// VerifyOptions specifies the configuration for the "verify" operation for the task. If nil, indicates that the
	// task is not a "verify" task.
	VerifyOptions *VerifyOptions `json:"verifyOptions"`

	// RegisterAsTopLevelDistgoTaskCommand indicates whether this task should be registered as a top-level command under
	// the "distgo-task" task. The command is always registered as a fully qualified command regardless of this value.
	// Even if this value is true, the command may not be registered as a top-level command if its name conflicts with
	// any default values or other with top-level commands registered by other assets.
	RegisterAsTopLevelDistgoTaskCommand bool `json:"registerAsTopLevelDistgoTaskCommand"`
}

TaskInfo is the information needed to create a distgo task. Based on the godel TaskInfo definition at https://github.com/palantir/godel/blob/8537d0ea9067d3bdd36d5db06069b71fde92188b/framework/pluginapi/v2/pluginapi/taskinfo.go#L44.

type VerifyOptions

type VerifyOptions struct {
	ApplyTrueArgs  []string `json:"applyTrueArgs"`
	ApplyFalseArgs []string `json:"applyFalseArgs"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL