gomodule

Documentation

Index

• func DetectChangelogSource(module, from, to string, depth int) *result.Changelogs
• type GoModule
  • func New(spec interface{}) (*GoModule, error)
  • func (g *GoModule) Changelog(from, to string) *result.Changelogs
  • func (g *GoModule) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
  • func (g *GoModule) ReportConfig() interface{}
  • func (g *GoModule) Source(workingDir string, resultSource *result.Source) error
  • func (g *GoModule) Target(source string, scm scm.ScmHandler, dryRun bool, releaseTarget *result.Target) error
• type Spec

Functions

func DetectChangelogSource

func DetectChangelogSource(module, from, to string, depth int) *result.Changelogs

DetectChangelogSource tries to identify based on the Goland module where the changelog is located. At the moment it only supports GitHub repositories both direct and from a proxy.

Types

type GoModule

type GoModule struct {
	Spec Spec

	Version version.Version
	// contains filtered or unexported fields
}

GoModule defines a resource of type "gomodule"

func New

func New(spec interface{}) (*GoModule, error)

New returns a reference to a newly initialized Go Module object from a godmodule.Spec or an error if the provided Spec triggers a validation error.

func (*GoModule) Changelog

func (g *GoModule) Changelog(from, to string) *result.Changelogs

Changelog returns the changelog for a specific golang module, or an empty string if it couldn't find one

func (*GoModule) Condition

func (g *GoModule) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)

Condition checks if a go module with a specific version is published

func (*GoModule) ReportConfig

func (g *GoModule) ReportConfig() interface{}

ReportConfig returns a new configuration without any sensitive information or context specific information.

func (*GoModule) Source

func (g *GoModule) Source(workingDir string, resultSource *result.Source) error

Source returns the latest go module version

func (*GoModule) Target

func (g *GoModule) Target(source string, scm scm.ScmHandler, dryRun bool, releaseTarget *result.Target) error

Target is not support for gomodule

type Spec

type Spec struct {
	// Proxy may have the schemes https, http. file is not supported at this time. If a URL has no scheme, https is assumed
	// [S][C] Proxy allows to override GO proxy similarly to GOPROXY environment variable.
	Proxy string `yaml:",omitempty"`
	// [S][C] Module specifies the name of the module
	Module string `yaml:",omitempty" jsonschema:"required"`
	// [C] Defines a specific package version
	Version string `yaml:",omitempty"`
	// [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	VersionFilter version.Filter `yaml:",omitempty"`
}

Spec defines a specification for a "gomodule" resource parsed from an updatecli manifest file