meta

Documentation

Overview

Package meta provides project options from source code.

Index

• type BuildArgs
  • func (args *BuildArgs) Add(arg ...string)
• type Command
• type Options

Types

type BuildArgs

type BuildArgs []string

BuildArgs defines input argument list.

func (*BuildArgs) Add

func (args *BuildArgs) Add(arg ...string)

Add adds the args to list if it doesn't exist already.

type Command

type Command struct {
	// Path defines command source path.
	Path string

	// Name defines command name.
	Name string
}

Command defines Golang executable build configuration.

type Options

type Options struct {
	// Config provider.
	Config *config.Provider

	// GitHub settings.
	GitHubOrganization string
	GitHubRepository   string

	// Git settings.
	MainBranch string

	// CanonicalPaths, import path for Go projects.
	CanonicalPaths []string

	// VersionPackagePath is a canonical path to version package directory.
	VersionPackagePath string

	// Directories which contain source code.
	Directories []string

	// JSDirectories which contain JS source code.
	JSDirectories []string

	// GoDirectories are directories containing Go source code.
	GoDirectories []string

	// ProtobufDirectories are directories containing .proto files.
	ProtobufDirectories []string

	// MarkdownDirectories are directories container Markdown files.
	MarkdownDirectories []string

	// Source files on top level.
	SourceFiles []string

	// Go source files on top level.
	GoSourceFiles []string

	// JS source files on top level.
	JSSourceFiles []string

	// Markdown source files on top level.
	MarkdownSourceFiles []string

	// Commands are top-level binaries to be built.
	Commands []Command

	// GoRootDirectories contans the list of all go.mod root directories.
	GoRootDirectories []string

	// BuildArgs passed down to Dockerfiles.
	BuildArgs BuildArgs

	// Path to /bin.
	BinPath string

	// GoContainerVersion is the default go official container version.
	GoContainerVersion string

	// Go's GOPATH.
	GoPath string

	// Path to ~/.cache.
	CachePath string

	// NpmCachePath path to node_modules.
	NpmCachePath string

	// ArtifactsPath binary output path.
	ArtifactsPath string

	// CIProvider specifies the CI provider. Currently drone/ghaction is supported.
	CIProvider string

	CompileGithubWorkflowsOnly bool

	// ContainerImageFrontend is the default frontend container image.
	ContainerImageFrontend string
}

Options for the project.