monorepo

Documentation

Index

• Constants
• Variables
• type Component
  • func (component Component) String() string
• type ComponentGraph

Constants

const ModeCurrentAffected = "current_affected"

ModeCurrentAffected will execute the specified commands if any of the current components dependecies have changed

const ModeCurrentChanged = "current_changed"

ModeCurrentChanged will execute the specified commands if the current component has changed

const ModeCurrentInvolved = "current_involved"

ModeCurrentInvolved will execute the specified commands if the current component or any of its dependecies have changed

Variables

var Main = &cobra.Command{
	Use:   "monorepo",
	Short: "Helpers for CircleCI Monorepo Support",
}

Main cobra command for monorepo support

Types

type Component

type Component struct {
	ID           string   `yaml:"id"`
	Name         string   `yaml:"name"`
	Dependencies []string `yaml:"deps"`
	Path         string   `yaml:"path"`
}

Component struct represent the configuration stored in yaml enriched by the relative path of the component in relation to the rootDirectory.

func (Component) String

func (component Component) String() string

type ComponentGraph

type ComponentGraph struct {
	// contains filtered or unexported fields
}

ComponentGraph struct represent the graph of all components found in the specified rootDirectory and its subdirectories.