pin

Documentation

Index

• func AutoPinOrchestrion()
• func PinOrchestrion(opts Options) error
• type Options

Functions

func AutoPinOrchestrion

func AutoPinOrchestrion()

AutoPinOrchestrion automatically runs `pinOrchestrion` if the necessary requirements are not already met. It prints messages to `os.Stderr` to inform the user about what is going on.

func PinOrchestrion

func PinOrchestrion(opts Options) error

PinOrchestrion applies or update the orchestrion pin file in the current working directory, according to the supplied Options.

Types

type Options

type Options struct {
	// Writer is the writer to send output of the command to.
	Writer io.Writer
	// ErrWriter is the writer to send error messages to.
	ErrWriter io.Writer

	// Validate checks the contents of all [orchestrionDotYML] files encountered
	// during the pinning process, ensuring they are valid according to the JSON
	// schema specification.
	Validate bool
	// NoGenerate disables emitting a `//go:generate` directive (which is
	// otherwise emitted to facilitate automated upkeep of the contents of the
	// [orchestrionToolGo] file).
	NoGenerate bool
	// NoPrune disables removing unnecessary imports from the [orchestrionToolGo]
	// file. It will instead only print warnings about these.
	NoPrune bool
}