tg

Documentation

Overview

Package tg implements functions to deal with Terragrunt files.

Index

• Constants
• type Module
• type Modules
  • func ScanModules(rootdir string, dir project.Path, trackDependencies bool) (Modules, error)

Constants

const ErrParsing errors.Kind = "parsing Terragrunt file"

ErrParsing indicates there is an error parsing a Terragrunt file.

Types

type Module

type Module struct {
	Path       project.Path  `json:"path"`
	Source     string        `json:"source"`
	ConfigFile project.Path  `json:"config"`
	After      project.Paths `json:"after,omitempty"`

	// DependsOn are paths that, when changed, must mark the module as changed.
	DependsOn project.Paths `json:"depends_on,omitempty"`
}

Module is a Terragrunt module.

type Modules

type Modules []*Module

Modules is a list of Module.

func ScanModules

func ScanModules(rootdir string, dir project.Path, trackDependencies bool) (Modules, error)

ScanModules scans dir looking for Terragrunt modules. It returns a list of modules with its "DependsOn paths" computed.