adr

Documentation

Index

• Constants
• func RunADRCommand(cmd, title, adrDir, adrConfigDir, adrTemplate string) error

Constants

const DOCKER_EXEC = ("docker run --rm -u {{.UID}}:{{.GID}} -v {{.AdrDir}}:/doc " +
	"-v {{.AdrConfigDir}}:/adr-config -e ADR_TEMPLATE=/adr-config/{{.AdrTemplate}} " +
	"brianskarda/adr-tools-docker adr {{.Cmd}}")

Functions

func RunADRCommand

func RunADRCommand(cmd, title, adrDir, adrConfigDir, adrTemplate string) error

RunADRCommand triggers given ADR command This function allows for these parameters to be configured:

• adrDir - directory which docker mounts as /docs
• adrConfigDir - directory with configuration which docker mounts as /adr-config
• adrTemplate - template name which will be used to produce ADRs.