git

Documentation

Overview

Package git implements the git interaction for effdump.

Index

• type VersionSystem
  • func New() *VersionSystem
  • func (*VersionSystem) HasChanges(context.Context) (bool, error)
  • func (*VersionSystem) Resolve(_ context.Context, rev string) (version string, err error)

Types

type VersionSystem

type VersionSystem struct{}

VersionSystem implements git version lookup via parsing `git` CLI tool's output. It uses the first ~7 characters of the full commit ID for the version strings.

func New

func New() *VersionSystem

New returns a new git VersionSystem.

func (*VersionSystem) HasChanges

func (*VersionSystem) HasChanges(context.Context) (bool, error)

HasChanges returns whether working dir has changes or not.

func (*VersionSystem) Resolve

func (*VersionSystem) Resolve(_ context.Context, rev string) (version string, err error)

Resolve resolves references such as HEAD or "ab12" to the full version string.