github

Documentation

Index

• Constants
• type ReleaseFileSpec
• type TaskRelease
  • func (c *TaskRelease) GetExecSpecs(rc dukkha.TaskExecContext, options dukkha.TaskMatrixExecOptions) ([]dukkha.TaskExecSpec, error)
  • func (c *TaskRelease) Key() dukkha.TaskKey
  • func (c *TaskRelease) Kind() dukkha.TaskKind
  • func (c *TaskRelease) Name() dukkha.TaskName
• type Tool
  • func (t *Tool) Init(cacheFS *fshelper.OSFS) error
  • func (t *Tool) Key() dukkha.ToolKey
  • func (t *Tool) Kind() dukkha.ToolKind
  • func (t *Tool) Name() dukkha.ToolName

Constants

const TaskKindRelease = "release"

const ToolKind = "github"

Types

type ReleaseFileSpec

type ReleaseFileSpec struct {
	rs.BaseField `yaml:"-"`

	// path to the file, can use glob
	Path string `yaml:"path"`
	// the display label as noted in gh docs
	// https://cli.github.com/manual/gh_release_create
	Label string `yaml:"label"`
}

type TaskRelease

type TaskRelease struct {
	rs.BaseField `yaml:"-"`

	TaskName string `yaml:"name"`

	tools.BaseTask `yaml:",inline"`

	Tag        string `yaml:"tag"`
	Draft      bool   `yaml:"draft"`
	PreRelease bool   `yaml:"pre_release"`
	Title      string `yaml:"title"`
	Notes      string `yaml:"notes"`

	Files []ReleaseFileSpec `yaml:"files"`
}

func (*TaskRelease) GetExecSpecs

func (c *TaskRelease) GetExecSpecs(
	rc dukkha.TaskExecContext, options dukkha.TaskMatrixExecOptions,
) ([]dukkha.TaskExecSpec, error)

func (*TaskRelease) Key

func (c *TaskRelease) Key() dukkha.TaskKey

func (*TaskRelease) Kind

func (c *TaskRelease) Kind() dukkha.TaskKind

func (*TaskRelease) Name

func (c *TaskRelease) Name() dukkha.TaskName

type Tool

type Tool struct {
	rs.BaseField `yaml:"-"`

	ToolName dukkha.ToolName `yaml:"name"`

	tools.BaseTool `yaml:",inline"`
}

func (*Tool) Init

func (t *Tool) Init(cacheFS *fshelper.OSFS) error

func (*Tool) Key

func (t *Tool) Key() dukkha.ToolKey

func (*Tool) Kind

func (t *Tool) Kind() dukkha.ToolKind

func (*Tool) Name

func (t *Tool) Name() dukkha.ToolName