types

package

v1.6.2 Latest Latest Go to latest Published: Jan 21, 2021 License: MIT Imports: 4 Imported by: 0

Details

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

Repository

github.com/yeqown/gitlab-flow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type BranchTyp
- func (b BranchTyp) String() string
type Config
- func (cfg *Config) Apply(debug, openBrowser bool) *Config
- func (cfg Config) Valid() error
type FlowContext
- func NewContext(cwd, confPath, projectName string, c *Config, forceRemote bool) *FlowContext
type ProjectBasics

Constants ¶

View Source

const (
	FeatureBranchPrefix = "feature/"
)

Variables ¶

View Source

var (
	ErrEmptyAccessToken = errors.New("empty access token")
	ErrEmptyGitlabAPI   = errors.New("empty gitlab API URL")
)

Functions ¶

This section is empty.

Types ¶

type BranchTyp ¶

type BranchTyp string

BranchTyp

const (
	MasterBranch BranchTyp = "master"
	DevBranch    BranchTyp = "develop"
	TestBranch   BranchTyp = "test"
)

func (BranchTyp) String ¶

func (b BranchTyp) String() string

type Config ¶

type Config struct {
	AccessToken  string `toml:"access_token"`
	DebugMode    bool   `toml:"debug"`
	GitlabAPIURL string `toml:"gitlab_api_url"`
	OpenBrowser  bool   `toml:"open_browser"`
}

Config contains all fields can be specified by user.

func (*Config) Apply ¶ added in v1.6.0

func (cfg *Config) Apply(debug, openBrowser bool) *Config

Apply open debug in Config if debug is true, otherwise do nothing.

func (Config) Valid ¶

func (cfg Config) Valid() error

Valid validates config is valid to use.

type FlowContext ¶

type FlowContext struct {
	// Conf of flow CLI.
	Conf *Config

	// CWD current working directory.
	CWD string

	// Project of current working directory, normally,
	// get from current working directory.
	Project *ProjectBasics
	// contains filtered or unexported fields
}

FlowContext contains all necessary parameters of flow command to execute.

func NewContext ¶

func NewContext(cwd, confPath, projectName string, c *Config, forceRemote bool) *FlowContext

NewContext be generated with non project information. Do not use Project directly!!!

func (*FlowContext) ConfPath ¶

func (c *FlowContext) ConfPath() string

ConfPath return configuration path

func (*FlowContext) ForceRemote ¶ added in v1.6.2

func (c *FlowContext) ForceRemote() bool

ForceRemote return should module need to locate project by projectName from remote. true means locate project from remote, false means do not jump the process of locating project from local.

func (*FlowContext) ProjectName ¶ added in v1.6.0

func (c *FlowContext) ProjectName() string

ProjectName return project name.

type ProjectBasics ¶

type ProjectBasics struct {
	ID     int
	Name   string
	WebURL string
}

ProjectBasics contains basic attributes of project.

Source Files ¶

View all Source files

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