template

Documentation

Overview

Package template provides template for creating new plugins.

Index

• Variables
• type Target
  • func (t Target) Run(rootDir string, data interface{}, dryRun bool) error

Variables

var BuildVersion = Target{
	Filepath: "BUILD_VERSION",
	Template: `0.0.1`,
}

BuildVersion target

var Codeowners = Target{
	Filepath: "CODEOWNERS",
	Template: `* @pbarker @vuil`,
}

Codeowners target TODO (pbarker): replace with the CLI reviewers group

var CommonMK = Target{
	Filepath: "common.mk",
	Template: plugintemplates.CommonMK,
}

CommonMK MK4 target

var DefaultInitTargets = []Target{
	GoMod,
	BuildVersion,
	GitIgnore,
	Makefile,
	Codeowners,
	MainReadMe,
	GolangCIConfig,
	Tools,
	CommonMK,
}

DefaultInitTargets are the default initialization targets.

var DefaultPluginTargets = []Target{
	PluginReadMe,
	PluginMain,
	PluginTest,
}

DefaultPluginTargets are the default plugin targets.

var GitHubCI = Target{
	Filepath: ".github/workflows/release.yaml",
	Template: plugintemplates.GithubWorkflowRelease,
}

GitHubCI target TODO (pbarker): should we push everything to a single repository, or at least make that possible? TODO (pbarker): should report stats

var GitIgnore = Target{
	Filepath: ".gitignore",
	Template: `/artifacts`,
}

GitIgnore target

var GitLabCI = Target{
	Filepath: ".gitlab-ci.yaml",
	Template: plugintemplates.GitlabCI,
}

GitLabCI target

var GoMod = Target{
	Filepath: "go.mod",
	Template: plugintemplates.Gomod,
}

GoMod target

var GolangCIConfig = Target{
	Filepath: ".golangci.yaml",
	Template: plugintemplates.GolangCIConfig,
}

GolangCIConfig target.

var MainReadMe = Target{
	Filepath: "README.md",
	Template: plugintemplates.PluginReadme,
}

MainReadMe target

var Makefile = Target{
	Filepath: "Makefile",
	Template: plugintemplates.Makefile,
}

Makefile target

var PluginMain = Target{
	Filepath: "cmd/plugin/{{ .PluginName | ToLower }}/main.go",
	Template: plugintemplates.MainGo,
}

PluginMain target TODO (pbarker): proper logging

var PluginReadMe = Target{
	Filepath: "cmd/plugin/{{ .PluginName }}/README.md",
	Template: plugintemplates.CommandReadme,
}

PluginReadMe target

var PluginTest = Target{
	Filepath: "cmd/plugin/{{ .PluginName }}/test/main.go",
	Template: plugintemplates.MainTestGo,
}

PluginTest target

var Tools = Target{
	Filepath: "tools/tools.go",
	Template: plugintemplates.ToolsGo,
}

Tools target.

Types

type Target

type Target struct {
	// Path of the file.
	Filepath string

	// Template to use.
	Template string
}

Target to template files.

func (Target) Run

func (t Target) Run(rootDir string, data interface{}, dryRun bool) error

Run the target.