commit

Documentation

Index

• type Author
• type Commit
  • func New(opts Options) (*Commit, error)
  • func (c *Commit) Create() error
• type Config
• type HeadCommit
• type Options
• type Placeholders

Types

type Author

type Author struct {
	Name  string
	Email string
}

type Commit

type Commit struct {
	Config  Config
	Author  Author
	Emoji   string
	Summary string
	Body    string
	Footer  string
	// contains filtered or unexported fields
}

func New

func New(opts Options) (*Commit, error)

func (*Commit) Create

func (c *Commit) Create() error

type Config

type Config struct {
	Authors      []Author
	Placeholders Placeholders
	LocalBranch  string
	RemoteBranch string
	BranchRefs   []string
	Remotes      []string
	HeadCommit   HeadCommit
	Emojis       []emoji.Emoji
	Amend        bool
}

type HeadCommit

type HeadCommit struct {
	Hash    string
	When    time.Time
	Emoji   emoji.Emoji
	Summary string
	Body    string
}

type Options

type Options struct {
	Apply bool
	Amend bool
}

type Placeholders

type Placeholders struct {
	Hash    string
	Summary string
	Body    string
}