autodiscovery

Documentation

Index

• Variables
• type AutoDiscovery
  • func New(spec Config, workDir string) (*AutoDiscovery, error)
  • func (g *AutoDiscovery) Run() ([][]byte, error)
• type Config
• type Crawler
• type CrawlersConfig
  • func (CrawlersConfig) JSONSchema() *jschema.Schema
• type GroupBy
  • func (g GroupBy) Validate() error

Variables

var (
	// DefaultGenericsSpecs defines the default builder that we want to run
	DefaultCrawlerSpecs = Config{
		Crawlers: CrawlersConfig{
			"cargo":         cargo.Spec{},
			"dockercompose": dockercompose.Spec{},
			"dockerfile":    dockerfile.Spec{},
			"golang/gomod":  golang.Spec{},
			"helm":          helm.Spec{},
			"helmfile":      helmfile.Spec{},
			"ko":            ko.Spec{},
			"kubernetes":    kubernetes.Spec{},
			"maven":         maven.Spec{},
			"npm":           npm.Spec{},
			"rancher/fleet": fleet.Spec{},
			"terraform":     &terraform.Spec{},
			"updatecli":     updatecli.Spec{},
		},
	}
	// AutodiscoverySpecs is a map of all Autodiscovery specification
	AutodiscoverySpecsMapping = map[string]interface{}{
		"cargo":         &cargo.Spec{},
		"dockercompose": &dockercompose.Spec{},
		"dockerfile":    &dockerfile.Spec{},
		"golang/gomod":  &golang.Spec{},
		"helm":          &helm.Spec{},
		"helmfile":      &helmfile.Spec{},
		"ko":            &ko.Spec{},
		"kubernetes":    &kubernetes.Spec{},
		"maven":         &maven.Spec{},
		"npm":           &npm.Spec{},
		"rancher/fleet": &fleet.Spec{},
		"terraform":     &terraform.Spec{},
		"updatecli":     &updatecli.Spec{},
	}
)

Types

type AutoDiscovery

type AutoDiscovery struct {
	// contains filtered or unexported fields
}

func New

func New(spec Config, workDir string) (*AutoDiscovery, error)

New returns an initiated autodiscovery object

func (*AutoDiscovery) Run

func (g *AutoDiscovery) Run() ([][]byte, error)

Run execute each Autodiscovery crawlers to generate Updatecli manifests

type Config

type Config struct {
	/*
		Crawlers defines a map of crawler configuration where the key represent the crawler type
	*/
	Crawlers CrawlersConfig `yaml:",omitempty"`
	/*
		scmid is a unique identifier used to retrieve the scm configuration from the configuration file.
	*/
	ScmId string `yaml:",omitempty"`
	/*
		actionid is a unique identifier used to retrieve the action configuration from the configuration file.
	*/
	ActionId string `yaml:",omitempty"`
	/*
		groupby specifies how to group pipeline. The Accepted is one of "all", "individual". Default is "all"

		default:
			all
	*/
	GroupBy GroupBy
	// !Deprecated in favor of `actionid`
	PullrequestId string `yaml:",omitempty"`
}

Config defines autodiscovery parameters

type Crawler

type Crawler interface {
	DiscoverManifests() ([][]byte, error)
}

type CrawlersConfig

type CrawlersConfig map[string]interface{}

CrawlersConfig is a custom type used to generated the jsonschema.

func (CrawlersConfig) JSONSchema

func (CrawlersConfig) JSONSchema() *jschema.Schema

JSONSchema implements the json schema interface to generate the "condition" jsonschema.

type GroupBy

type GroupBy string

const (
	GROUPBYALL        GroupBy = "all"
	GROUPBYINDIVIDUAL GroupBy = "individual"
)

func (GroupBy) Validate

func (g GroupBy) Validate() error