Documentation
¶
Index ¶
- func CheckLock(directory string) error
- func Clean(directory string) error
- func Docs(directory string) error
- func DocsFix(directory string) error
- func FindTerraformProjects(base string) ([]string, error)
- func HasChanges(terraformProjects []string) (bool, error)
- func HasTerraformDocsConfig(dir string) bool
- func Init(directory string) error
- func InitUpgrade(directory string) error
- func IsTerraformProject(p string, d fs.DirEntry) bool
- func IsTerraformSubmodule(dir string) bool
- func Lint(directory, tfLintCfg string) error
- func LintFix(directory, tfLintCfg string) error
- func ProviderLock(directory string) error
- func Security(directory string) error
- func Test(directory string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Docs ¶ added in v0.6.0
Docs validate if the README of a module are up to date with the content of the module
func FindTerraformProjects ¶
FindTerraformProjects will search through the base directory to find the all terraform projects
func HasChanges ¶ added in v0.8.0
HasChanges checks if the current branch has any terraform changes compared to the main branch
func HasTerraformDocsConfig ¶ added in v0.14.2
HasTerraformDocsConfig checks whether the given directory contains a terraform-docs.yml configuration file.
func InitUpgrade ¶
InitUpgrade downloads and updates Terraform modules locally
func IsTerraformProject ¶
IsTerraformProject returns true if a directory contains a go module.
func IsTerraformSubmodule ¶ added in v0.20.2
IsTerraformSubmodule returns true if the directory is a subdirectory of another terraform project.
func ProviderLock ¶
ProviderLock updates the provider lock file locking poviders for a list of os architecures
Types ¶
This section is empty.
Source Files