config

package

v0.0.0-...-b6ab1de Latest Latest Go to latest Published: Sep 29, 2022 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	DefaultRepositoryDir = "docs/decisions"
	DefaultConfigExt     = "yaml"
	DefaultConfigName    = ".adr"
)

This section is empty.

func Find(repoDir string, num int) (string, error)

Find will return the repoDir/NNN-file-name.md for the specified ADR number if it exists in the repoDir

func Link(p *LinkPair) error

Link will use the LinkPair to insert links into the 'Status' section

func Sanitize(title string) string

Sanitize ensures that the given string matches Title expectations (e.g. lowercase, no spaces, etc)

func Supersede(p *LinkPair) error

Supersede will change the Source status to 'Superseded' and link to the Target. It will also append the 'Supersedes' backlink to the Target status

func UpdateStatus(path, to string) error

UpdateStatus will search for the Status section and replace the existing status with the 'to' status

type ADR struct {
	FormatName    string
	TitleTemplate string
	BodyTemplate  string
}

func (a *ADR) New(repoDir string, values map[string]string) error

New will create a new ADR using the in-memory configuration. It will determine the next number for the new ADR and write a new file to repoDir

type Config struct {
	WorkingDirectory string `yaml:"-"`
	CfgFileName      string `yaml:"-"`
	CfgFileExt       string `yaml:"-"`
	*Repository
	*ADR
}

func NewDefaultConfig() *Config

func (c *Config) CreateAndWrite() error

CreateAndWrite creates a file from the current structs values and then calls Write with it

func (c *Config) EnsureRepositoryExists() error

EnsureRepositoryExists creates the repository directory if it doesn't exist. ADRs will be stored in this directory

func (c *Config) Managed() (bool, error)

Managed checks if the current working directory is already managed by this tool

func (c *Config) Write(w io.Writer) error

Write writes the current struct to the given io.Writer

type LinkPair struct {
	SourceNum int
	TargetNum int
	SourceMsg string
	BackMsg   string
	RepoDir   string
}

type Repository struct {
	Path string `yaml:"path"`
}

Repository contains the metadata for an ADR repository (e.g. configurations, path, etc)