command

package

v1.13.2 Latest Latest Go to latest Published: May 7, 2025 License: Apache-2.0 Imports: 25 Imported by: 0

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
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 = "---"
)

Variables ¶

This section is empty.

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 ¶ added in v1.8.0

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

func NewChangeLogGenerator ¶ added in v1.8.0

func NewChangeLogGenerator(rootPath string) *ChangeLogGenerator

func (*ChangeLogGenerator) ChangeLogInit ¶ added in v1.8.0

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

func (*ChangeLogGenerator) ChangeVersion ¶ added in v1.10.0

func (c *ChangeLogGenerator) ChangeVersion() error

func (*ChangeLogGenerator) CheckLocalFileChangeByArgs ¶ added in v1.13.1

func (c *ChangeLogGenerator) CheckLocalFileChangeByArgs() error

func (*ChangeLogGenerator) CheckRepository ¶ added in v1.8.0

func (c *ChangeLogGenerator) CheckRepository() error

func (*ChangeLogGenerator) CheckWorktreeDirty ¶ added in v1.8.1

func (c *ChangeLogGenerator) CheckWorktreeDirty() error

func (*ChangeLogGenerator) DoChangeRepoFileByCommitLog ¶ added in v1.8.0

func (c *ChangeLogGenerator) DoChangeRepoFileByCommitLog() error

func (*ChangeLogGenerator) DoGitOperator ¶ added in v1.8.0

func (c *ChangeLogGenerator) DoGitOperator() error

func (*ChangeLogGenerator) DryRun ¶ added in v1.8.0

func (c *ChangeLogGenerator) DryRun()

func (*ChangeLogGenerator) DryRunChangeVersion ¶ added in v1.10.0

func (c *ChangeLogGenerator) DryRunChangeVersion()

func (*ChangeLogGenerator) GenerateCommitAsMdNodes ¶ added in v1.8.0

func (c *ChangeLogGenerator) GenerateCommitAsMdNodes() error

func (*ChangeLogGenerator) GetGitRemoteInfo ¶ added in v1.8.0

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

func (*ChangeLogGenerator) GetHeadBranchName ¶ added in v1.8.0

func (c *ChangeLogGenerator) GetHeadBranchName() string

func (*ChangeLogGenerator) GetHistoryFirstTagName ¶ added in v1.8.0

func (c *ChangeLogGenerator) GetHistoryFirstTagName() string

func (*ChangeLogGenerator) GetLatestCommits ¶ added in v1.8.0

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

func (*ChangeLogGenerator) LoadRepository ¶ added in v1.8.0

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

load git repository info.

type ChangeLogGeneratorFunc ¶ added in v1.8.0

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

	CheckLocalFileChangeByArgs() error

	DryRun()

	DoChangeRepoFileByCommitLog() error

	DoGitOperator() error

	DryRunChangeVersion()

	ChangeVersion() 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
	IsOnlyChangeVersion    bool

	AppendMonoRepoPath []string
	AppendMonoRepoAll  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
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
exit_cli
subcommand_init
subcommand_read_latest

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