commit

Documentation

Overview

Package branch provides use-cases for creating or updating a branch.

Index

• Variables
• type Commit
  • func (u *Commit) Do(ctx context.Context, in Input) error
• type Input
• type Interface

Variables

var Set = wire.NewSet(
	wire.Struct(new(Commit), "*"),
	wire.Bind(new(Interface), new(*Commit)),
)

Types

type Commit

type Commit struct {
	CreateGitObject gitobject.Interface
	FileSystem      fs.Interface
	Logger          logger.Interface
	GitHub          github.Interface
}

Commit commits files to the default/given branch on the repository.

func (*Commit) Do

func (u *Commit) Do(ctx context.Context, in Input) error

type Input

type Input struct {
	TargetRepository git.RepositoryID
	TargetBranchName git.BranchName // if empty, target is the default branch
	ParentRepository git.RepositoryID
	CommitStrategy   commitstrategy.CommitStrategy
	CommitMessage    git.CommitMessage
	Author           *git.CommitAuthor // optional
	Committer        *git.CommitAuthor // optional
	Paths            []string          // if empty or nil, create an empty commit
	NoFileMode       bool
	DryRun           bool

	ForceUpdate bool //TODO: support force-update as well
}

type Interface

type Interface interface {
	Do(ctx context.Context, in Input) error
}