git

Documentation

Overview

Package git provides shared tooling that other plugins can use to interact with the git repository consistently with other git plugins.

Index

• Constants
• Variables
• func GetPropertyGitReleaseBranch(ctx context.Context) (string, error)
• func GetPropertyGitReleaseTag(ctx context.Context) (string, error)
• func GetPropertyGitTargetBranch(ctx context.Context) string
• func ReleaseBranchRefName(ctx context.Context) (plumbing.ReferenceName, error)
• func ReleaseBranchRefSpec(ctx context.Context) (gitConfig.RefSpec, error)
• func ReleaseTagRefSpec(ctx context.Context) (gitConfig.RefSpec, error)
• func TargetBranch(ctx context.Context) string
• func TargetBranchRefName(ctx context.Context) plumbing.ReferenceName
• type Git
  • func (g *Git) Remote() *git.Remote
  • func (g *Git) Repository() *git.Repository
  • func (g *Git) SetupGitRepo(ctx context.Context) error
  • func (g *Git) Worktree() *git.Worktree

Constants

const (
	PropertyReleaseBranchPrefix = "release-v"
	DefaultGitTargetBranch      = "master"

	PropertyGitReleaseTag    = "git.release.tag"
	PropertyGitReleaseBranch = "git.release.branch"
	PropertyGitTargetBranch  = "git.target.branch"
)

Variables

var IgnoreStatus = map[string]struct{}{
	".session.vim": {},
}

IgnoreStatus defines some global files to always ignore when checking for dirtiness.

Functions

func GetPropertyGitReleaseBranch

func GetPropertyGitReleaseBranch(ctx context.Context) (string, error)

func GetPropertyGitReleaseTag

func GetPropertyGitReleaseTag(ctx context.Context) (string, error)

func GetPropertyGitTargetBranch

func GetPropertyGitTargetBranch(ctx context.Context) string

func ReleaseBranchRefName

func ReleaseBranchRefName(ctx context.Context) (plumbing.ReferenceName, error)

func ReleaseBranchRefSpec

func ReleaseBranchRefSpec(ctx context.Context) (gitConfig.RefSpec, error)

func ReleaseTagRefSpec

func ReleaseTagRefSpec(ctx context.Context) (gitConfig.RefSpec, error)

func TargetBranch

func TargetBranch(ctx context.Context) string

func TargetBranchRefName

func TargetBranchRefName(ctx context.Context) plumbing.ReferenceName

Types

type Git

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

Git provides tools for working with a Git repository. It sets up client objects to work with the local repository, the remote repository, and the local work tree.

func (*Git) Remote

func (g *Git) Remote() *git.Remote

func (*Git) Repository

func (g *Git) Repository() *git.Repository

func (*Git) SetupGitRepo

func (g *Git) SetupGitRepo(ctx context.Context) error

func (*Git) Worktree

func (g *Git) Worktree() *git.Worktree