fastforward

Documentation

Index

• type FastForward
  • func New(opts *Options) *FastForward
  • func (f *FastForward) Run() (err error)
• type Options

Types

type FastForward

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

FastForward is the main structure of this package.

func New

func New(opts *Options) *FastForward

New returns a new FastForward instance.

func (*FastForward) Run

func (f *FastForward) Run() (err error)

Run starts the FastForward.

type Options

type Options struct {
	// GitHubOrg is the GitHub Organization to be used do the initial clone.
	GitHubOrg string

	// GitHubRepo is the GitHub Repository to be used do the initial clone.
	GitHubRepo string

	// Branch is the release branch to be fast forwarded.
	Branch string

	// MainRef is the git ref of the base branch.
	MainRef string

	// Submit can be used to run inside of a new Google Cloud Build job.
	Submit bool

	// NonInteractive does not ask any questions if set to true.
	NonInteractive bool

	// NoMock actually pushes the changes if set to true.
	NoMock bool

	// Cleanup the repository after the run if set to true.
	Cleanup bool

	// RepoPath is the local path to the repository to be used.
	RepoPath string

	// GCPProjectID is the GCP project to use to submit the job.
	GCPProjectID string
}

Options is the main structure for configuring a fast forward.