git

Documentation

Index

• Variables
• func ArtifactCommitMessage(service, artifactID, author string) string
• func BranchFromHead(ctx context.Context, repo *git.Repository, artifactFileName, svc string) (string, error)
• func BranchName(modifiedFiles []string, artifactFileName, svc string) (string, bool)
• func CommitterDetails() (string, string, error)
• func PolicyUpdateApplyCommitMessage(env, service, branch, policy string) string
• func PolicyUpdateDeleteCommitMessage(service string) string
• func ReleaseCommitMessage(env, service, artifactID string) string
• func RollbackCommitMessage(env, service, oldArtifactID, newArtifactID string) string
• func TempDir(ctx context.Context, tracer tracing.Tracer, prefix string) (string, func(context.Context), error)
• func TempDirAsync(ctx context.Context, tracer tracing.Tracer, prefix string) (string, func(context.Context), error)
• type Service
  • func (s *Service) Checkout(ctx context.Context, rootPath string, hash plumbing.Hash) error
  • func (s *Service) Clone(ctx context.Context, destination string) (*git.Repository, error)
  • func (s *Service) Commit(ctx context.Context, ...) error
  • func (s *Service) InitMasterRepo(ctx context.Context) (func(context.Context), error)
  • func (s *Service) LocateArtifact(ctx context.Context, r *git.Repository, artifactID string) (plumbing.Hash, error)
  • func (s *Service) LocateArtifacts(ctx context.Context, r *git.Repository, service string, n int) ([]plumbing.Hash, error)
  • func (s *Service) LocateEnvRelease(ctx context.Context, r *git.Repository, env, artifactID string) (plumbing.Hash, error)
  • func (s *Service) LocateRelease(ctx context.Context, r *git.Repository, artifactID string) (plumbing.Hash, error)
  • func (s *Service) LocateServiceRelease(ctx context.Context, r *git.Repository, env, service string) (plumbing.Hash, error)
  • func (s *Service) LocateServiceReleaseRollbackSkip(ctx context.Context, r *git.Repository, env, service string, n uint) (plumbing.Hash, error)
  • func (s *Service) SyncMaster(ctx context.Context) error

Variables

var (
	ErrNothingToCommit    = errors.New("nothing to commit")
	ErrReleaseNotFound    = errors.New("release not found")
	ErrArtifactNotFound   = errors.New("artifact not found")
	ErrBranchBehindOrigin = errors.New("branch behind origin")
	ErrUnknownGit         = errors.New("unknown git error")
)

Functions

func ArtifactCommitMessage

func ArtifactCommitMessage(service, artifactID, author string) string

ArtifactCommitMessage returns an artifact commit message.

func BranchFromHead

func BranchFromHead(ctx context.Context, repo *git.Repository, artifactFileName, svc string) (string, error)

BranchFromHead reutrns the branch name from the current HEAD commit.

It only handles files that originates from a build operation, ie. non-build commits cannot be extracted.

func BranchName

func BranchName(modifiedFiles []string, artifactFileName, svc string) (string, bool)

BranchName returns the branch name and a bool indicating one is found from a list of modified file paths.

It only handles files that originates from a build operation, ie. non-build commits cannot be extracted.

func CommitterDetails

func CommitterDetails() (string, string, error)

CommitterDetails returns name and email read for a Git configuration file.

Configuration files are read first in the local git repository (if available) and then read the global Git configuration.

func PolicyUpdateApplyCommitMessage

func PolicyUpdateApplyCommitMessage(env, service, branch, policy string) string

PolicyUpdateApplyCommitMessage returns an apply policy commit message.

func PolicyUpdateDeleteCommitMessage

func PolicyUpdateDeleteCommitMessage(service string) string

PolicyUpdateDeleteCommitMessage returns a delete policy commit message.

func ReleaseCommitMessage

func ReleaseCommitMessage(env, service, artifactID string) string

ReleaseCommitMessage returns an artifact release commit message.

func RollbackCommitMessage

func RollbackCommitMessage(env, service, oldArtifactID, newArtifactID string) string

RollbackCommitMessage returns an artifact rollback commit message.

func TempDir

func TempDir(ctx context.Context, tracer tracing.Tracer, prefix string) (string, func(context.Context), error)

TempDir returns a temporary directory with provided prefix. The first return argument is the path. The second is a close function to remove the path.

func TempDirAsync

func TempDirAsync(ctx context.Context, tracer tracing.Tracer, prefix string) (string, func(context.Context), error)

TempDirSync returns a temporary directory with provided prefix. The first return argument is the path. The second is a close function to remove the path asynchronously.

Types

type Service

type Service struct {
	Tracer            tracing.Tracer
	SSHPrivateKeyPath string
	ConfigRepoURL     string
	// contains filtered or unexported fields
}

func (*Service) Checkout

func (s *Service) Checkout(ctx context.Context, rootPath string, hash plumbing.Hash) error

func (*Service) Clone

func (s *Service) Clone(ctx context.Context, destination string) (*git.Repository, error)

Clone returns a Git repository copy from the master repository.

func (*Service) Commit

func (s *Service) Commit(ctx context.Context, rootPath, changesPath, authorName, authorEmail, committerName, committerEmail, msg string) error

func (*Service) InitMasterRepo

func (s *Service) InitMasterRepo(ctx context.Context) (func(context.Context), error)

InitMasterRepo clones the configuration repository into a master directory.

func (*Service) LocateArtifact

func (s *Service) LocateArtifact(ctx context.Context, r *git.Repository, artifactID string) (plumbing.Hash, error)

LocateArtifact traverses the git log to find an artifact commit with id artifactID.

It expects the commit to have a commit messages as the one returned by ArtifactCommitMessage.

func (*Service) LocateArtifacts

func (s *Service) LocateArtifacts(ctx context.Context, r *git.Repository, service string, n int) ([]plumbing.Hash, error)

LocateArtifacts traverses the git log to find artifact commits for a service.

It expects the commit to have a commit messages as the one returned by ArtifactCommitMessage.

func (*Service) LocateEnvRelease

func (s *Service) LocateEnvRelease(ctx context.Context, r *git.Repository, env, artifactID string) (plumbing.Hash, error)

LocateEnvRelease traverses the git log to find a release commit for a specified environment and artifactID.

It expects the commit to have a commit messages as the one returned by ReleaseCommitMessage.

func (*Service) LocateRelease

func (s *Service) LocateRelease(ctx context.Context, r *git.Repository, artifactID string) (plumbing.Hash, error)

LocateRelease traverses the git log to find a release commit with id artifactID.

It expects the commit to have a commit messages as the one returned by ReleaseCommitMessage.

func (*Service) LocateServiceRelease

func (s *Service) LocateServiceRelease(ctx context.Context, r *git.Repository, env, service string) (plumbing.Hash, error)

LocateServiceRelease traverses the git log to find a release commit for a specified service and environment.

It expects the commit to have a commit messages as the one returned by ReleaseCommitMessage.

func (*Service) LocateServiceReleaseRollbackSkip

func (s *Service) LocateServiceReleaseRollbackSkip(ctx context.Context, r *git.Repository, env, service string, n uint) (plumbing.Hash, error)

LocateServiceReleaseRollbackSkip traverses the git log to find a release or rollback commit for a specified service and environment.

It expects the commit to have a commit messages as the one returned by ReleaseCommitMessage or RollbackCommitMessage.

func (*Service) SyncMaster

func (s *Service) SyncMaster(ctx context.Context) error

SyncMaster pulls latest changes from master repo.