projectconfig

Documentation

Index

• Constants
• Variables
• func CreateProjectConfigFile(dir string, projectName string, projectContext *ZeroProjectConfig) error
• func ReadVendorCredentialsFromModule(m Module, vendor string) (error, string)
• func SetRootDir(dir string)
• type Condition
• type Files
• type Module
  • func NewModule(parameters Parameters, directory string, repository string, source string, ...) Module
• type Modules
• type Parameters
• type ZeroProjectConfig
  • func LoadConfig(filePath string) *ZeroProjectConfig
  • func (c *ZeroProjectConfig) GetDAG() dag.AcyclicGraph
  • func (c *ZeroProjectConfig) Print()

Constants

const GraphRootName = "graphRoot"

GraphRootName represents the root of the graph of modules in a project

Variables

var RootDir = "./"

Functions

func CreateProjectConfigFile

func CreateProjectConfigFile(dir string, projectName string, projectContext *ZeroProjectConfig) error

CreateProjectConfigFile extracts the required content for zero project config file then write to disk.

func ReadVendorCredentialsFromModule

func ReadVendorCredentialsFromModule(m Module, vendor string) (error, string)

ReadVendorCredentialsFromModule uses parsed project-config's module based on vendor parameter, retrieve the vendor's credential for pre-defined functionalities (eg: Github api key for pushing repos to github)

func SetRootDir

func SetRootDir(dir string)

Types

type Condition

type Condition struct {
	Action     string   `yaml:"action"`
	MatchField string   `yaml:"matchField"`
	WhenValue  string   `yaml:"whenValue"`
	Data       []string `yaml:"data,omitempty"`
}

type Files

type Files struct {
	Directory  string `yaml:"dir,omitempty"`
	Repository string `yaml:"repo,omitempty"`
	Source     string
}

type Module

type Module struct {
	DependsOn  []string   `yaml:"dependsOn,omitempty"`
	Parameters Parameters `yaml:"parameters,omitempty"`
	Files      Files
	Conditions []Condition `yaml:"conditions,omitempty"`
}

func NewModule

func NewModule(parameters Parameters, directory string, repository string, source string, dependsOn []string, conditions []Condition) Module

type Modules

type Modules map[string]Module

type Parameters

type Parameters map[string]string

type ZeroProjectConfig

type ZeroProjectConfig struct {
	Name                   string `yaml:"name"`
	ShouldPushRepositories bool   `yaml:"shouldPushRepositories"`
	Parameters             map[string]string
	Modules                Modules `yaml:"modules"`
}

func LoadConfig

func LoadConfig(filePath string) *ZeroProjectConfig

func (*ZeroProjectConfig) GetDAG

func (c *ZeroProjectConfig) GetDAG() dag.AcyclicGraph

GetDAG returns a graph of the module names used in this project config

func (*ZeroProjectConfig) Print

func (c *ZeroProjectConfig) Print()