step

Documentation

Index

• func BuildVerify() error
• func Execute(steps []Step) error
• func Generate() error
• func GetDependencies(dependencies []string) func() error
• func ModTidy() error
• func ModVendor() error
• func TerraformInit() error
• func TerraformInitFast() error
• func TerraformRequire() error
• type Step
  • func Backup(path string) Step
  • func Build(pkg string, target string, goEnvs ...string) Step
  • func Chdir(path string) Step
  • func Delete(path string) Step
  • func InitProjectPath(path string, finalModulePath *string) Step
  • func ModInit(finalModulePath *string) Step
  • func PackageZip(source string, target string) Step
  • func PackageZipRename(source string, target string, newSourceName string) Step
  • func PluginInstall(pkg, version, target string) Step
  • func RenderTemplate(fs embed.FS, source string, target string, variables interface{}) Step
  • func RenderTemplates(fs embed.FS, prefix string, variables interface{}) Step
  • func TerraformApply(workspace string, args ...string) Step
  • func TerraformDestroy(workspace string, args ...string) Step
  • func TerraformNewWorkspace(workspace string) Step
  • func TerraformPlan(workspace string, args ...string) Step

Functions

func BuildVerify

func BuildVerify() error

BuildVerify creates a step that ensures the validity of the generated project.

func Execute

func Execute(steps []Step) error

Execute runs the provided steps.

func Generate

func Generate() error

Generate creates a step that runs go generate for all files.

func GetDependencies

func GetDependencies(dependencies []string) func() error

GetDependencies creates a step that downloads the specified dependencies.

func ModTidy

func ModTidy() error

ModTidy creates a step that runs go mod tidy.

func ModVendor

func ModVendor() error

ModVendor creates a step that runs go mod vendor.

func TerraformInit

func TerraformInit() error

TerraformInit creates a step that runs terraform init with the upgrade flag.

func TerraformInitFast

func TerraformInitFast() error

TerraformInitFast creates a step that runs terraform init without the upgrade flag.

func TerraformRequire

func TerraformRequire() error

TerraformRequire creates a step that ensures that terraform is installed.

Types

type Step

type Step func() error

Step defines the function interface for an action to be performed.

func Backup

func Backup(path string) Step

Backup creates a step that backups the provided file path.

func Build

func Build(pkg string, target string, goEnvs ...string) Step

Build creates a step that runs go build.

func Chdir

func Chdir(path string) Step

Chdir creates a step that changes the directory to the provided path.

func Delete

func Delete(path string) Step

Delete creates a step that removes the provided file.

func InitProjectPath

func InitProjectPath(path string, finalModulePath *string) Step

InitProjectPath creates a step that gathers information about the project path.

func ModInit

func ModInit(finalModulePath *string) Step

ModInit creates a step that initializes the go module.

func PackageZip

func PackageZip(source string, target string) Step

PackageZip creates a step that packages the source into a zip file.

func PackageZipRename

func PackageZipRename(source string, target string, newSourceName string) Step

PackageZipRename packages source file into target zip, the resulting zip contains the source file but named with newSourceName

func PluginInstall

func PluginInstall(pkg, version, target string) Step

PluginInstall creates a step that installs the provided plugin.

func RenderTemplate

func RenderTemplate(fs embed.FS, source string, target string, variables interface{}) Step

RenderTemplate creates a step that renders the provided template.

func RenderTemplates

func RenderTemplates(fs embed.FS, prefix string, variables interface{}) Step

RenderTemplates creates a step that renders the provided templates.

func TerraformApply

func TerraformApply(workspace string, args ...string) Step

TerraformApply creates a step that runs terraform apply with the provided arguments.

func TerraformDestroy

func TerraformDestroy(workspace string, args ...string) Step

TerraformDestroy creates a step that runs terraform destroy with the provided arguments.

func TerraformNewWorkspace

func TerraformNewWorkspace(workspace string) Step

TerraformNewWorkspace creates a step that initializes a new terraform workspace if it does not yet exist.

func TerraformPlan

func TerraformPlan(workspace string, args ...string) Step

TerraformPlan creates a step that runs terraform plan with the provided arguments.