golang

Documentation

Index

• Constants
• func Create(options map[string]interface{}) (map[string]interface{}, error)
• func Delete(options map[string]interface{}) (bool, error)
• func InitRepoLocalAndPushToRemote(repoPath string, opts *Options, ghClient *github.Client) error
• func MergeCommits(ghClient *github.Client, mainBranch string) error
• func Read(options map[string]interface{}) (map[string]interface{}, error)
• func Render(filePath string, opts *Options) ([]byte, error)
• func Update(options map[string]interface{}) (map[string]interface{}, error)
• func WalkLocalRepoPath(repoPath string, opts *Options, ghClient *github.Client) error
• type Config
• type Options
• type Repo

Constants

const (
	DefaultWorkPath      = ".github-repo-scaffolding-golang"
	DefaultTemplateRepo  = "dtm-scaffolding-golang"
	DefaultTemplateOwner = "merico-dev"
	TransitBranch        = "init-with-devstream"
	DefaultMainBranch    = "main"
)

Functions

func Create

func Create(options map[string]interface{}) (map[string]interface{}, error)

Create installs github-repo-scaffolding-golang with provided options.

func Delete

func Delete(options map[string]interface{}) (bool, error)

Delete uninstalls github-repo-scaffolding-golang with provided options.

func InitRepoLocalAndPushToRemote

func InitRepoLocalAndPushToRemote(repoPath string, opts *Options, ghClient *github.Client) error

func MergeCommits

func MergeCommits(ghClient *github.Client, mainBranch string) error

func Read

func Read(options map[string]interface{}) (map[string]interface{}, error)

Read check the health for github-repo-scaffolding-golang with provided param.

func Render

func Render(filePath string, opts *Options) ([]byte, error)

func Update

func Update(options map[string]interface{}) (map[string]interface{}, error)

Update re-installs github-repo-scaffolding-golang with provided options.

func WalkLocalRepoPath

func WalkLocalRepoPath(repoPath string, opts *Options, ghClient *github.Client) error

Types

type Config

type Config struct {
	AppName   string
	ImageRepo string
	Repo      Repo
}

type Options

type Options struct {
	Owner     string
	Repo      string
	Branch    string
	ImageRepo string `mapstructure:"image_repo"`
}

TODO(daniel-hutao): Param should keep as same as other plugins named Param or keep as same as plugin github-actions?

type Repo

type Repo struct {
	Name  string
	Owner string
}