ensure

Documentation

Index

• func RequiredVersion(ctx context.Context) error
• type IncorrectVersionError
  • func (e IncorrectVersionError) Error() string

Functions

func RequiredVersion

func RequiredVersion(ctx context.Context) error

RequiredVersion makes sure the version of the tool currently running is the same as the one required in the current working directory's "go.mod" file.

If this returns `nil`, the current process is running the correct version of the tool and can proceed with it's intended purpose. If it returns an IncorrectVersionError, the caller should determine whether to print a warning or exit in error, presenting the returned error to the user.

Types

type IncorrectVersionError

type IncorrectVersionError struct {
	// RequiredVersion is the version declared in `go.mod`, or a blank string if a `replace` directive
	// for "github.com/DataDog/orchestrion" is present in `go.mod`.
	RequiredVersion string
}

IncorrectVersionError is returned by RequiredVersion when the version of orchestrion running does not match the one required by `go.mod`.

func (IncorrectVersionError) Error

func (e IncorrectVersionError) Error() string