commitpipeline

Documentation

Overview

Package commitpipeline handles all work related to commits

Index

• func IdentifySameBranch(branchA, branchB string, gitRepo *history.Git) (bool, error)
• type Options
• type Pipeline
  • func New(options *Options, args ...string) (*Pipeline, error)
  • func (Pipeline) Name() string
  • func (pipeline *Pipeline) Run() (*dispatcher.PipelineSuccess, error)

Functions

func IdentifySameBranch

func IdentifySameBranch(branchA, branchB string, gitRepo *history.Git) (bool, error)

IdentifySameBranch breaks up the reference names and tries to identify if the branches are the same

Types

type Options

type Options struct {
	// Path to repository
	Path string
	// UpstreamBranch is the branch against which to check
	UpstreamBranch string
	// Limit will limit how far back to check on upstream branch.
	Limit int
	// AllCommits will check all the commits on the upstream branch. Regardless of Limit setting.
	AllCommits bool
	Strict     bool
	// RequiredScopes will check scope in commit message against list of required ones
	RequiredScopes []string
}

type Pipeline

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

func New

func New(options *Options, args ...string) (*Pipeline, error)

func (Pipeline) Name

func (Pipeline) Name() string

func (*Pipeline) Run

func (pipeline *Pipeline) Run() (*dispatcher.PipelineSuccess, error)