git

package

v0.4.2 Latest Latest Go to latest Published: Jun 4, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/FollowTheProcess/tag

Links

Open Source Insights

Documentation ¶

Overview ¶

Package git implements tags interface with git in order to interact with tags and make commits.

Index ¶

Variables
func Add() error
func Branch() (string, error)
func Commit(message string) (string, error)
func CreateTag(tag, message string) (string, error)
func IsDirty() (bool, error)
func IsRepo() bool
func LatestTag() (string, error)
func ListTags(limit int) (tags string, limitHit bool, err error)
func Push() (string, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoTagsFound = errors.New("No tags found") // ErrNoTagsFound is the signal that the current repo has no tags
)

Functions ¶

func Add ¶

func Add() error

Add stages all files.

func Branch ¶

func Branch() (string, error)

Branch gets the name of the current git branch.

func Commit ¶

func Commit(message string) (string, error)

Commit performs a git commit with a message.

func CreateTag ¶

func CreateTag(tag, message string) (string, error)

CreateTag creates an annotated git tag with an optional message if the message is an empty string, the tag name will be used.

func IsDirty ¶

func IsDirty() (bool, error)

IsDirty checks whether or not the working tree is dirty.

func IsRepo ¶

func IsRepo() bool

IsRepo detects whether or not we are currently in a git repo.

func LatestTag ¶

func LatestTag() (string, error)

LatestTag returns the name of the latest tag.

func ListTags(limit int) (tags string, limitHit bool, err error)

ListTags lists all tags in descending order (latest at the top).

func Push ¶

func Push() (string, error)

Push performs a git push to the configured remote.

Types ¶