commit

package

v1.15.1 Latest Latest Go to latest Published: Oct 23, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/int128/ghcp

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is empty.

Types ¶

type Commit ¶

type Commit struct {
	CreateGitObject gitobject.Interface
	FileSystem      fs.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
}

Source Files ¶

View all Source files

commit.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL