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 GetAutodiscoverySpecsMapping = sync.OnceValue(func() CrawlersConfig {
	ret := make(CrawlersConfig, len(crawlerMap))
	for k, v := range crawlerMap {
		ret[k] = v.spec
	}
	return ret
})

GetAutodiscoverySpecs return a map of all Autodiscovery specification

var GetDefaultCrawlerSpecs = sync.OnceValue(func() Config {
	ret := Config{
		Crawlers: make(CrawlersConfig, len(crawlerMap)),
	}
	for k, v := range crawlerMap {
		if v.ignoreDefault {
			continue
		}
		ret.Crawlers[k] = v.spec
	}
	return ret
})

GetDefaultCrawlerSpecs return config that defines the default builder that we want to run

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

This function is responsible to create all the crawlers

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]any

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