mage

Documentation

Index

• Variables
• func CheckNoChanges() error
• func GenerateNotice(overrides, rules, noticeTemplate string) error
• func GitDiff() error
• func GitDiffIndex() ([]string, error)
• func InstallGoLicenser() error
• func InstallGoNoticeGen() error
• type Deps
  • func (Deps) CheckModuleTidy() error
• type Linter
  • func (l Linter) All() error
  • func (Linter) CheckConfig() error
  • func (Linter) ForceInstall() error
  • func (Linter) Install() error
  • func (l Linter) LastChange() error
  • func (l Linter) Version() error

Variables

var (
	// GoLicenserImportPath controls the import path used to install go-licenser.
	GoLicenserImportPath = "github.com/elastic/go-licenser"

	// GoNoticeGeneratorImportPath controls the import path used to install go-licence-detector.
	GoNoticeGeneratorImportPath = "go.elastic.co/go-licence-detector"
)

Functions

func CheckNoChanges

func CheckNoChanges() error

func GenerateNotice

func GenerateNotice(overrides, rules, noticeTemplate string) error

func GitDiff

func GitDiff() error

GitDiff runs 'git diff' and writes the output to stdout.

func GitDiffIndex

func GitDiffIndex() ([]string, error)

GitDiffIndex returns a list of files that differ from what is committed. These could file that were created, deleted, modified, or moved.

func InstallGoLicenser

func InstallGoLicenser() error

InstallGoLicenser target installs go-licenser

func InstallGoNoticeGen

func InstallGoNoticeGen() error

InstallGoLicenser target installs go-licenser

Types

type Deps

type Deps mg.Namespace

Deps contains targets related to checking dependencies

func (Deps) CheckModuleTidy

func (Deps) CheckModuleTidy() error

CheckModuleTidy checks if `go mod tidy` was run before the last commit.

type Linter

type Linter mg.Namespace

Linter contains targets related to linting the Go code

func (Linter) All

func (l Linter) All() error

All runs the linter against the entire codebase

func (Linter) CheckConfig

func (Linter) CheckConfig() error

CheckConfig makes sure that the `.golangci.yml` does not have uncommitted changes

func (Linter) ForceInstall

func (Linter) ForceInstall() error

ForceInstall force installs the linter regardless of whether it exists or not.

func (Linter) Install

func (Linter) Install() error

Install installs golangci-lint (https://golangci-lint.run) to `./build` using the official installation script downloaded from GitHub. If the linter binary already exists does nothing.

func (Linter) LastChange

func (l Linter) LastChange() error

LastChange runs the linter against all files changed since the fork point from `main`. If the current branch is `main` then runs against the files changed in the last commit.

func (Linter) Version

func (l Linter) Version() error

Prints the version of the linter in use.