mage

Documentation

Index

• func CheckGitConfigExists() bool
• func EnsureBoilerplateScript(version, boilerplateScript string, forceInstall bool) error
• func EnsureCosign(version string) error
• func EnsureGitConfig() error
• func EnsureGolangCILint(version string, forceInstall bool) error
• func EnsureKO(version string) error
• func EnsureZeitgeist(version string) error
• func GenerateLDFlags() (string, error)
• func InstallCosign(version string) error
• func InstallKO(version string) error
• func RunGolangCILint(version string, forceInstall bool, args ...string) error
• func TestGo(verbose bool, pkgs ...string) error
• func TestGoWithTags(verbose bool, tags string, pkgs ...string) error
• func VerifyBoilerplate(version, binDir, boilerplateDir string, forceInstall bool) error
• func VerifyBuild(scriptDir string) error
• func VerifyDeps(version, basePath, configPath string, localOnly bool) error
• func VerifyGoMod() error

Functions

func CheckGitConfigExists

func CheckGitConfigExists() bool

func EnsureBoilerplateScript

func EnsureBoilerplateScript(version, boilerplateScript string, forceInstall bool) error

EnsureBoilerplateScript downloads copyright header boilerplate script, if not already present in the repository.

func EnsureCosign

func EnsureCosign(version string) error

EnsureCosign makes sure that the specified cosign version is available

func EnsureGitConfig

func EnsureGitConfig() error

func EnsureGolangCILint

func EnsureGolangCILint(version string, forceInstall bool) error

Ensure golangci-lint is installed and on the PATH.

func EnsureKO

func EnsureKO(version string) error

EnsureKO

func EnsureZeitgeist

func EnsureZeitgeist(version string) error

Ensure zeitgeist is installed and on the PATH.

func GenerateLDFlags

func GenerateLDFlags() (string, error)

GenerateLDFlags returns the string to use in the `-ldflags` flag.

func InstallCosign

func InstallCosign(version string) error

InstallCosign installs the required cosign version

func InstallKO

func InstallKO(version string) error

Maybe we can move this to release-utils

func RunGolangCILint

func RunGolangCILint(version string, forceInstall bool, args ...string) error

RunGolangCILint runs all golang linters

func TestGo

func TestGo(verbose bool, pkgs ...string) error

func TestGoWithTags

func TestGoWithTags(verbose bool, tags string, pkgs ...string) error

func VerifyBoilerplate

func VerifyBoilerplate(version, binDir, boilerplateDir string, forceInstall bool) error

VerifyBoilerplate runs copyright header checks

func VerifyBuild

func VerifyBuild(scriptDir string) error

VerifyBuild builds the project for a chosen set of platforms

func VerifyDeps

func VerifyDeps(version, basePath, configPath string, localOnly bool) error

VerifyDeps runs zeitgeist to verify dependency versions

func VerifyGoMod

func VerifyGoMod() error

VerifyGoMod runs `go mod tidy` and `git diff --exit-code go.*` to ensure all module updates have been checked in.