Documentation
¶
Index ¶
- type Client
- func (c *Client) Authors() ([]string, error)
- func (c *Client) Commit(msg []byte, opts CommitOptions) (CommitSummary, error)
- func (c *Client) CreateBranch(name, baseBranch string) error
- func (c *Client) DefaultBaseBranch() (string, error)
- func (c *Client) IsMergedInto(branchName, baseBranch string) (bool, error)
- func (c *Client) LocalBranchNames() ([]string, error)
- func (c *Client) WorkingTreeRoot() (string, error)
- type CommitOptions
- type CommitSummary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client wraps a go-git repository and exposes commit operations.
func (*Client) Authors ¶
Authors returns a deduplicated, alphabetically sorted list of commit author strings ("Name <email>") from the repository history. The current git config identity is prepended as the first (default) entry.
func (*Client) Commit ¶
func (c *Client) Commit(msg []byte, opts CommitOptions) (CommitSummary, error)
Commit records a commit with msg and the given options. It returns a CommitSummary suitable for printing to the user.
func (*Client) CreateBranch ¶
CreateBranch creates a new branch from baseBranch and checks it out.
func (*Client) DefaultBaseBranch ¶
DefaultBaseBranch resolves the default base branch in priority order:
- refs/remotes/origin/HEAD
- "main" if the local ref exists
- "master" if the local ref exists
func (*Client) IsMergedInto ¶
IsMergedInto reports whether branchName's tip commit is reachable from baseBranch, i.e. whether the branch has been merged into base (mirrors git merge-base --is-ancestor).
func (*Client) LocalBranchNames ¶
LocalBranchNames returns the short names of all local branches.
func (*Client) WorkingTreeRoot ¶
WorkingTreeRoot returns the absolute path of the repository's working tree root.
type CommitOptions ¶
type CommitOptions struct {
All bool
Amend bool
// NoVerify — go-git v6 does not execute hooks; reserved for a future subprocess fallback.
NoVerify bool
Signoff bool
AllowEmpty bool
Author string // "Name <email>"; empty = git config identity
}
CommitOptions configures Client.Commit.
Source Files