github

Documentation

Index

• Constants
• func BuildWorkFlowsWrapper(workflows []*github.Workflow) plugininstaller.MutableOperation
• func GetActionState(options plugininstaller.RawOptions) (statemanager.ResourceState, error)
• func GetStaticWorkFlowState(options plugininstaller.RawOptions) (statemanager.ResourceState, error)
• func ProcessAction(act action) plugininstaller.BaseOperation
• func Validate(options plugininstaller.RawOptions) (plugininstaller.RawOptions, error)
• type Build
• type Coverage
• type Docker
  • func (d *Docker) Validate() []error
• type GithubActionLanguage
• type GithubActionOptions
  • func NewGithubActionOptions(options plugininstaller.RawOptions) (*GithubActionOptions, error)
  • func (opts *GithubActionOptions) CheckAddDockerHubToken() bool
  • func (opts *GithubActionOptions) Encode() (map[string]interface{}, error)
  • func (opts *GithubActionOptions) GetGithubClient() (*github.Client, error)
  • func (opts *GithubActionOptions) GetLanguage() string
  • func (opts *GithubActionOptions) RenderWorkFlow(content string) (string, error)
• type Image
• type Registry
• type RegistryType
• type Tag
• type Test

Constants

const (
	ActionCreate action = "create"
	ActionDelete action = "delete"
	ActionUpdate action = "update"
)

const (
	RegistryDockerhub   RegistryType = "dockerhub"
	RegistryHarbor      RegistryType = "harbor"
	CommitMessage                    = "GitHub Actions workflow, created by DevStream"
	PRBuilderFileName                = "pr-builder.yml"
	MainBuilderFileName              = "main-builder.yml"
)

Functions

func BuildWorkFlowsWrapper

func BuildWorkFlowsWrapper(workflows []*github.Workflow) plugininstaller.MutableOperation

func GetActionState

func GetActionState(options plugininstaller.RawOptions) (statemanager.ResourceState, error)

func GetStaticWorkFlowState

func GetStaticWorkFlowState(options plugininstaller.RawOptions) (statemanager.ResourceState, error)

func ProcessAction

func ProcessAction(act action) plugininstaller.BaseOperation

ProcessAction config github

func Validate

func Validate(options plugininstaller.RawOptions) (plugininstaller.RawOptions, error)

Types

type Build

type Build struct {
	Enable  bool
	Command string
}

Build is the struct for githubactions job.

type Coverage

type Coverage struct {
	Enable  bool
	Profile string
	Output  string
}

Coverage is the struct for githubactions job.

type Docker

type Docker struct {
	Enable   bool
	Registry Registry
}

Docker is the struct for githubactions job.

func (*Docker) Validate

func (d *Docker) Validate() []error

type GithubActionLanguage

type GithubActionLanguage struct {
	Name    string `validate:"required"`
	Version string
}

GithubActionLanguage is the language of repo

type GithubActionOptions

type GithubActionOptions struct {
	Owner    string                `validate:"required_without=Org"`
	Org      string                `validate:"required_without=Owner"`
	Repo     string                `validate:"required"`
	Branch   string                `validate:"required"`
	Language *GithubActionLanguage `validate:"required"`

	// optional
	Workflows []*github.Workflow
	Build     Build
	Test      *Test
	Docker    *Docker
}

GithubActionOptions is the struct for configurations of the plugin.

func NewGithubActionOptions

func NewGithubActionOptions(options plugininstaller.RawOptions) (*GithubActionOptions, error)

func (*GithubActionOptions) CheckAddDockerHubToken

func (opts *GithubActionOptions) CheckAddDockerHubToken() bool

func (*GithubActionOptions) Encode

func (opts *GithubActionOptions) Encode() (map[string]interface{}, error)

func (*GithubActionOptions) GetGithubClient

func (opts *GithubActionOptions) GetGithubClient() (*github.Client, error)

func (*GithubActionOptions) GetLanguage

func (opts *GithubActionOptions) GetLanguage() string

func (*GithubActionOptions) RenderWorkFlow

func (opts *GithubActionOptions) RenderWorkFlow(content string) (string, error)

type Image

type Image struct {
}

Image is the struct for githubactions job.

type Registry

type Registry struct {
	// only support dockerhub now
	Type       RegistryType
	Username   string
	Repository string
}

type RegistryType

type RegistryType string

type Tag

type Tag struct {
}

Tag is the struct for githubactions job.

type Test

type Test struct {
	Enable   bool
	Command  string
	Coverage Coverage
}

Test is the struct for githubactions job.