source

Documentation

Index

• Constants
• type Info
• type Parser
  • func NewParser(typ string) (Parser, error)

Constants

const (
	// ParserTypeGit is the type of parser for git repositories.
	ParserTypeGit = "git"

	// ParserTypeZeta is the type of parser for zeta repositories.
	ParserTypeZeta = "zeta"
)

Types

type Info

type Info struct {
	// URL is the URL of the source.
	// e.g git is the origin remote URL.
	URL string
	// Commit is the commit hash of the source.
	// e.g git is the HEAD commit hash.
	Commit string
	// Dirty is true if the source is dirty.
	// e.g git is indicating whether the workspace is dirty.
	Dirty bool
}

Info is a struct that holds the source information.

type Parser

type Parser interface {
	Parse(workspace string) (*Info, error)
}

Parser is an interface for parsing the source information.

func NewParser

func NewParser(typ string) (Parser, error)