project

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Int(i int) *int
• func String(str string) *string
• func StringSlice(s []string) *[]string
• type IProject
  • func InitProject() (IProject, error)
• type Project
  • func GetConfig() (*Project, error)
  • func (proj *Project) CreateBuildWorkflow() error
  • func (proj *Project) CreateReadme() error
  • func (proj *Project) CreateReleaseWorkflow() error
  • func (proj *Project) GetAuthorEmail() string
  • func (proj *Project) GetAuthorName() string
  • func (proj *Project) GetAuthorOrganization() string
  • func (proj *Project) GetCodeOwners() []string
  • func (proj *Project) GetDefaultReleaseBranch() string
  • func (proj *Project) GetDescription() string
  • func (proj *Project) GetGitHubToken() string
  • func (proj *Project) GetGitignore() []string
  • func (proj *Project) GetGoTestArgs() []string
  • func (proj *Project) GetGoVersion() string
  • func (proj *Project) GetGojenVersion() string
  • func (proj *Project) GetName() string
  • func (proj *Project) GetRepository() string
  • func (proj *Project) IsBuildWorkflow() bool
  • func (proj *Project) IsCreateReadme() bool
  • func (proj *Project) IsGoLinter() bool
  • func (proj *Project) IsGoTest() bool
  • func (proj *Project) IsIsGojen() bool
  • func (proj *Project) IsLicensed() bool
  • func (proj *Project) IsRelease() bool
  • func (proj *Project) RunLinter() error
  • func (proj *Project) RunTest() error
  • func (proj *Project) SetCodeOwners() error
  • func (proj *Project) SetGitignore() error
  • func (proj *Project) SetupProject() error
  • func (proj *Project) ValidateConfig() error
  • func (proj *Project) WriteConfig() error

Variables

var CI bool

Functions

func Bool

func Bool(b bool) *bool

func Int

func Int(i int) *int

func String

func String(str string) *string

func StringSlice

func StringSlice(s []string) *[]string

Types

type IProject

type IProject interface {
	WriteConfig() error
	SetupProject() error
	SetGitignore() error
	CreateReadme() error
	RunTest() error
	RunLinter() error

	GetName() string
	GetDescription() string
	GetRepository() string
	GetAuthorName() string
	GetAuthorEmail() string
	GetAuthorOrganization() string
	IsLicensed() bool
	IsRelease() bool
	GetDefaultReleaseBranch() string
	GetGitignore() []string
	GetCodeOwners() []string
	IsGoLinter() bool
	IsGoTest() bool
	GetGoTestArgs() []string
	IsBuildWorkflow() bool
	GetGitHubToken() string
	GetGojenVersion() string
	IsIsGojen() bool
	IsCreateReadme() bool
}

func InitProject

func InitProject() (IProject, error)

type Project

type Project struct {
	Name        *string `yaml:"name" json:"name"`
	Description *string `yaml:"description" json:"description"`
	Repository  *string `yaml:"repository"  json:"repository"`
	GoVersion   *string `yaml:"goVersion" json:"goVersion"`

	AuthorName         *string `yaml:"authorName" json:"authorName"`
	AuthorEmail        *string `yaml:"authorEmail" json:"authorEmail"`
	AuthorOrganization *string `yaml:"authorOrganization" json:"authorOrganization"`

	Licensed     *bool   `yaml:"licensed" json:"licensed"`
	Readme       *bool   `yaml:"readme" json:"readme"`
	GojenVersion *string `yaml:"gojenVersion" json:"gojenVersion"`

	Release              *bool   `yaml:"release" json:"release"`
	BuildWorkflow        *bool   `yaml:"buildWorkflow" json:"buildWorkflow"`
	GithubToken          *string `yaml:"githubToken" json:"githubToken"`
	DefaultReleaseBranch *string `yaml:"defaultReleaseBranch" json:"defaultReleaseBranch"`
	IsGojen              *bool   `yaml:"isGojen" json:"isGojen"`

	Gitignore  *[]string `yaml:"gitignore" json:"gitignore"`
	CodeOwners *[]string `yaml:"codeOwners" json:"codeOwners"`

	GoLinter   *bool     `yaml:"goLinter" json:"goLinter"`
	GoTest     *bool     `yaml:"goTest" json:"goTest"`
	GoTestArgs *[]string `yaml:"goTestArgs" json:"goTestArgs"`
}

func GetConfig

func GetConfig() (*Project, error)

func (*Project) CreateBuildWorkflow

func (proj *Project) CreateBuildWorkflow() error

func (*Project) CreateReadme

func (proj *Project) CreateReadme() error

func (*Project) CreateReleaseWorkflow

func (proj *Project) CreateReleaseWorkflow() error

func (*Project) GetAuthorEmail

func (proj *Project) GetAuthorEmail() string

func (*Project) GetAuthorName

func (proj *Project) GetAuthorName() string

func (*Project) GetAuthorOrganization

func (proj *Project) GetAuthorOrganization() string

func (*Project) GetCodeOwners

func (proj *Project) GetCodeOwners() []string

func (*Project) GetDefaultReleaseBranch

func (proj *Project) GetDefaultReleaseBranch() string

func (*Project) GetDescription

func (proj *Project) GetDescription() string

func (*Project) GetGitHubToken

func (proj *Project) GetGitHubToken() string

func (*Project) GetGitignore

func (proj *Project) GetGitignore() []string

func (*Project) GetGoTestArgs

func (proj *Project) GetGoTestArgs() []string

func (*Project) GetGoVersion

func (proj *Project) GetGoVersion() string

func (*Project) GetGojenVersion

func (proj *Project) GetGojenVersion() string

func (*Project) GetName

func (proj *Project) GetName() string

func (*Project) GetRepository

func (proj *Project) GetRepository() string

func (*Project) IsBuildWorkflow

func (proj *Project) IsBuildWorkflow() bool

func (*Project) IsCreateReadme

func (proj *Project) IsCreateReadme() bool

func (*Project) IsGoLinter

func (proj *Project) IsGoLinter() bool

func (*Project) IsGoTest

func (proj *Project) IsGoTest() bool

func (*Project) IsIsGojen

func (proj *Project) IsIsGojen() bool

func (*Project) IsLicensed

func (proj *Project) IsLicensed() bool

func (*Project) IsRelease

func (proj *Project) IsRelease() bool

func (*Project) RunLinter

func (proj *Project) RunLinter() error

func (*Project) RunTest

func (proj *Project) RunTest() error

func (*Project) SetCodeOwners

func (proj *Project) SetCodeOwners() error

func (*Project) SetGitignore

func (proj *Project) SetGitignore() error

func (*Project) SetupProject

func (proj *Project) SetupProject() error

func (*Project) ValidateConfig

func (proj *Project) ValidateConfig() error

func (*Project) WriteConfig

func (proj *Project) WriteConfig() error