golang

Documentation

Index

• Constants
• type Golang
  • func New(spec interface{}, rootDir, scmID, actionID string) (Golang, error)
  • func (n Golang) DiscoverManifests() ([][]byte, error)
• type MatchingRule
• type MatchingRules
• type Spec

Constants

const (
	GoModFile string = "go.mod"
)

Types

type Golang

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

Golang holds all information needed to generate golang manifest.

func New

func New(spec interface{}, rootDir, scmID, actionID string) (Golang, error)

New return a new valid object.

func (Golang) DiscoverManifests

func (n Golang) DiscoverManifests() ([][]byte, error)

type MatchingRule

type MatchingRule struct {
	// Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring.
	Path string
	// Modules specifies a list of module pattern.
	Modules map[string]string
	// GoVersions specifies a list of version pattern.
	GoVersion string
}

MatchingRule allows to specifies rules to identify manifest

type MatchingRules

type MatchingRules []MatchingRule

type Spec

type Spec struct {
	// rootDir defines the root directory used to recursively search for golang go.mod
	RootDir string `yaml:",omitempty"`
	// OnlyGoVersion allows to specify if the autodiscovery should only handle Go version specified in go.mod
	OnlyGoVersion *bool `yaml:",omitempty"`
	// OnlyGoModule allows to specify if the autodiscovery should only handle Go module specified in go.mod
	OnlyGoModule *bool `yaml:",omitempty"`
	// ignore allows to specify "rule" to ignore autodiscovery a specific go.mod rule
	Ignore MatchingRules `yaml:",omitempty"`
	/*
		`only` allows to specify rule to "only" autodiscover manifest for a specific golang rule
	*/
	Only MatchingRules `yaml:",omitempty"`
	/*
		`versionfilter` provides parameters to specify the version pattern to use when generating manifest.

		kind - semver
			versionfilter of kind `semver` uses semantic versioning as version filtering
			pattern accepts one of:
				`patch` - patch only update patch version
				`minor` - minor only update minor version
				`major` - major only update major versions
				`a version constraint` such as `>= 1.0.0`

		kind - regex
			versionfilter of kind `regex` uses regular expression as version filtering
			pattern accepts a valid regular expression

		example:
		“`
			versionfilter:
				kind: semver
				pattern: minor
		“`

		and its type like regex, semver, or just latest.
	*/
	VersionFilter version.Filter `yaml:",omitempty"`
}

Spec defines the parameters which can be provided to the Golang autodiscovery builder.