command

Documentation

Index

• Constants
• func GlobalAction(c *cli.Context) error
• func GlobalAfterAction(c *cli.Context) error
• func GlobalBeforeAction(c *cli.Context) error
• func GlobalFlag() []cli.Flag
• func HideGlobalFlag() []cli.Flag
• func MainFlag() []cli.Flag
• type ChangeLogGenerator
  • func NewChangeLogGenerator(rootPath string) *ChangeLogGenerator
  • func (c *ChangeLogGenerator) ChangeLogInit(cfg GenerateConfig, spec *convention.ConventionalChangeLogSpec) error
  • func (c *ChangeLogGenerator) CheckRepository() error
  • func (c *ChangeLogGenerator) CheckWorktreeDirty() error
  • func (c *ChangeLogGenerator) DoChangeRepoFileByCommitLog() error
  • func (c *ChangeLogGenerator) DoGitOperator() error
  • func (c *ChangeLogGenerator) DryRun()
  • func (c *ChangeLogGenerator) GenerateCommitAsMdNodes() error
  • func (c *ChangeLogGenerator) GetGitRemoteInfo() git_info.GitRemoteInfo
  • func (c *ChangeLogGenerator) GetHeadBranchName() string
  • func (c *ChangeLogGenerator) GetHistoryFirstTagName() string
  • func (c *ChangeLogGenerator) GetLatestCommits() []git.Commit
  • func (c *ChangeLogGenerator) LoadRepository(gitCloneUrl, remote string) error
• type ChangeLogGeneratorFunc
• type GenerateConfig
• type GlobalCommand
  • func CmdGlobalEntry() *GlobalCommand
• type GlobalConfig

Constants

const (
	KitName    = "convention-change-log"
	KitUrl     = "https://github.com/convention-change/convention-change-log"
	LogLineSpe = "---"
)

Functions

func GlobalAction

func GlobalAction(c *cli.Context) error

GlobalAction do command Action flag.

func GlobalAfterAction

func GlobalAfterAction(c *cli.Context) error

GlobalAfterAction

do command Action after flag global.

func GlobalBeforeAction

func GlobalBeforeAction(c *cli.Context) error

GlobalBeforeAction do command Action before flag global.

func GlobalFlag

func GlobalFlag() []cli.Flag

GlobalFlag Other modules also have flags

func HideGlobalFlag

func HideGlobalFlag() []cli.Flag

func MainFlag

func MainFlag() []cli.Flag

MainFlag main flags

Types

type ChangeLogGenerator

type ChangeLogGenerator struct {
	ChangeLogGeneratorFunc `json:"-"`
	// contains filtered or unexported fields
}

func NewChangeLogGenerator

func NewChangeLogGenerator(rootPath string) *ChangeLogGenerator

func (*ChangeLogGenerator) ChangeLogInit

func (c *ChangeLogGenerator) ChangeLogInit(cfg GenerateConfig, spec *convention.ConventionalChangeLogSpec) error

func (*ChangeLogGenerator) CheckRepository

func (c *ChangeLogGenerator) CheckRepository() error

func (*ChangeLogGenerator) CheckWorktreeDirty

func (c *ChangeLogGenerator) CheckWorktreeDirty() error

func (*ChangeLogGenerator) DoChangeRepoFileByCommitLog

func (c *ChangeLogGenerator) DoChangeRepoFileByCommitLog() error

func (*ChangeLogGenerator) DoGitOperator

func (c *ChangeLogGenerator) DoGitOperator() error

func (*ChangeLogGenerator) DryRun

func (c *ChangeLogGenerator) DryRun()

func (*ChangeLogGenerator) GenerateCommitAsMdNodes

func (c *ChangeLogGenerator) GenerateCommitAsMdNodes() error

func (*ChangeLogGenerator) GetGitRemoteInfo

func (c *ChangeLogGenerator) GetGitRemoteInfo() git_info.GitRemoteInfo

func (*ChangeLogGenerator) GetHeadBranchName

func (c *ChangeLogGenerator) GetHeadBranchName() string

func (*ChangeLogGenerator) GetHistoryFirstTagName

func (c *ChangeLogGenerator) GetHistoryFirstTagName() string

func (*ChangeLogGenerator) GetLatestCommits

func (c *ChangeLogGenerator) GetLatestCommits() []git.Commit

func (*ChangeLogGenerator) LoadRepository

func (c *ChangeLogGenerator) LoadRepository(gitCloneUrl, remote string) error

LoadRepository load git repository info

type ChangeLogGeneratorFunc

type ChangeLogGeneratorFunc interface {
	LoadRepository(gitCloneUrl, remote string) error

	CheckRepository() error

	CheckWorktreeDirty() error

	GetHeadBranchName() string

	GetGitRemoteInfo() git_info.GitRemoteInfo

	ChangeLogInit(cfg GenerateConfig, spec *convention.ConventionalChangeLogSpec) error

	GetHistoryFirstTagName() string

	GetLatestCommits() []git.Commit

	GenerateCommitAsMdNodes() error

	DryRun()

	DoChangeRepoFileByCommitLog() error

	DoGitOperator() error
}

type GenerateConfig

type GenerateConfig struct {
	GitCloneUrl string

	GitInfoScheme string

	ReleaseAs  string
	TagPrefix  string
	ReleaseTag string

	Infile  string
	Outfile string

	FromCommit string

	AutoPush bool

	SkipWorktreeDirtyCheck bool
}

type GlobalCommand

type GlobalCommand struct {
	Name    string
	Version string
	Verbose bool
	DryRun  bool

	GitRootPath   string
	GitRemote     string
	ChangeLogSpec *convention.ConventionalChangeLogSpec

	RootCfg GlobalConfig

	GenerateConfig GenerateConfig
}

GlobalCommand

command root

func CmdGlobalEntry

func CmdGlobalEntry() *GlobalCommand

CmdGlobalEntry

return global command entry

type GlobalConfig

type GlobalConfig struct {
	LogLevel      string
	TimeoutSecond uint
}