manifest

package

v1.1.0 Latest Latest Go to latest Published: Jun 12, 2019 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-gilbert/gilbert

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Manifest
- func (m *Manifest) Location() string
type Mixin
- func (m Mixin) ToTask(parentVars sdk.Vars) (t Task)
type Mixins
type Task
- func (t Task) AsyncJobsCount() (count int)
- func (t Task) Clone(vars sdk.Vars) Task
type TaskSet

Constants ¶

View Source

const (
	// FileName is default manifest filename
	FileName = "gilbert.yaml"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Manifest ¶

type Manifest struct {
	// Plugins is plugins import list
	Plugins []string `yaml:"plugins,omitempty"`

	// Version is gilbert file format version
	Version string `yaml:"version"`

	// Imports is list of imported presets
	Imports []string `yaml:"imports,omitempty"`

	// Vars is a set of global variables
	Vars sdk.Vars `yaml:"vars,omitempty"`

	// Tasks is a set of tasks
	Tasks TaskSet `yaml:"tasks,omitempty"`

	// Mixins is a set of declared mixins
	Mixins Mixins `yaml:"mixins,omitempty"`
	// contains filtered or unexported fields
}

Manifest represents manifest file (gilbert.yaml)

func FromDirectory ¶ added in v0.2.0

func FromDirectory(dir string) (m *Manifest, err error)

FromDirectory loads gilbert.yaml from specified directory

func LoadManifest ¶ added in v0.5.0

func LoadManifest(path string) (*Manifest, error)

LoadManifest loads manifest from specified path and it's imports

func UnmarshalManifest ¶

func UnmarshalManifest(data []byte) (m *Manifest, err error)

UnmarshalManifest parses yaml contents into manifest structure

func (*Manifest) Location ¶ added in v0.2.0

func (m *Manifest) Location() string

Location returns manifest file location, if it was loaded using FromDirectory method

type Mixin ¶ added in v0.3.0

type Mixin []sdk.Job

Mixin represents a mixin declaration

func (Mixin) ToTask ¶ added in v0.3.0

func (m Mixin) ToTask(parentVars sdk.Vars) (t Task)

ToTask creates a new task from mixin with variables for override

type Mixins ¶ added in v0.3.0

type Mixins map[string]Mixin

Mixins is a pair of mixin name and params

type Task ¶

type Task []sdk.Job

Task is a group of jobs

func (Task) AsyncJobsCount ¶ added in v0.4.0

func (t Task) AsyncJobsCount() (count int)

AsyncJobsCount returns count of async jobs in the task

func (Task) Clone ¶ added in v0.11.0

func (t Task) Clone(vars sdk.Vars) Task

Clone creates a new task copy with specified variables

type TaskSet ¶

type TaskSet map[string]Task

TaskSet is a set of tasks declared in a manifest file

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
template

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