git

Documentation

Overview

Package git provides VCS utility functions to interact with Git repositories.

See https://git-scm.com for more details about Git.

Index

• type Git
  • func New(opts ...Option) *Git
  • func (g *Git) DeriveVersion() error
  • func (g *Git) Kind() vcs.Kind
  • func (g *Git) Version() interface{}
• type Option
  • func WithDefaultVersion(defaultVersion string) Option
  • func WithPath(path string) Option
• type Options

Types

type Git

type Git struct {
	// contains filtered or unexported fields
}

Git represents a Git repository.

See https://git-scm.com for more details.

func New

func New(opts ...Option) *Git

New creates a new repository.

func (*Git) DeriveVersion

func (g *Git) DeriveVersion() error

DeriveVersion derives the repository version based on Git metadata.

References

(1) https://git-scm.com/docs/git-tag
(2) https://git-scm.com/book/en/v2/Git-Internals-Git-Objects
(3) https://git-scm.com/book/en/v2/Git-Internals-Git-References

func (*Git) Kind

func (g *Git) Kind() vcs.Kind

Kind returns the repository Kind.

func (*Git) Version

func (g *Git) Version() interface{}

Version returns the repository version as type *Version.

type Option

type Option func(*Options)

Option is a repository option.

func WithDefaultVersion

func WithDefaultVersion(defaultVersion string) Option

WithDefaultVersion sets the default version.

func WithPath

func WithPath(path string) Option

WithPath sets the repository path.

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options stores repository options.