capi

Documentation

Index

• func CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams, r TemplatePullRequester, ...) error
• func GetCredentials(r CredentialsRetriever, w io.Writer) error
• func GetTemplateParameters(name string, r TemplatesRetriever, w io.Writer) error
• func GetTemplates(r TemplatesRetriever, w io.Writer) error
• func GetTemplatesByProvider(provider string, r TemplatesRetriever, w io.Writer) error
• func RenderTemplateWithParameters(name string, parameters map[string]string, creds Credentials, ...) error
• type CreatePullRequestFromTemplateParams
• type Credentials
• type CredentialsRetriever
• type Template
• type TemplateParameter
• type TemplatePullRequester
• type TemplateRenderer
• type TemplatesRetriever

Functions

func CreatePullRequestFromTemplate

func CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams, r TemplatePullRequester, w io.Writer) error

CreatePullRequestFromTemplate uses a TemplatePullRequester adapter to create a pull request from a CAPI template.

func GetCredentials

func GetCredentials(r CredentialsRetriever, w io.Writer) error

GetCredentials uses a CredentialsRetriever adapter to show a list of CAPI credentials.

func GetTemplateParameters

func GetTemplateParameters(name string, r TemplatesRetriever, w io.Writer) error

GetTemplateParameters uses a TemplatesRetriever adapter to show a list of parameters for a given template.

func GetTemplates

func GetTemplates(r TemplatesRetriever, w io.Writer) error

GetTemplates uses a TemplatesRetriever adapter to show a list of templates to the console.

func GetTemplatesByProvider

func GetTemplatesByProvider(provider string, r TemplatesRetriever, w io.Writer) error

GetTemplatesByProvider uses a TemplatesRetriever adapter to show a list of templates for a given provider to the console.

func RenderTemplateWithParameters

func RenderTemplateWithParameters(name string, parameters map[string]string, creds Credentials, r TemplateRenderer, w io.Writer) error

RenderTemplate uses a TemplateRenderer adapter to show a template populated with parameter values.

Types

type CreatePullRequestFromTemplateParams

type CreatePullRequestFromTemplateParams struct {
	TemplateName    string
	ParameterValues map[string]string
	RepositoryURL   string
	HeadBranch      string
	BaseBranch      string
	Title           string
	Description     string
	CommitMessage   string
	Credentials     Credentials
}

type Credentials

type Credentials struct {
	Group     string
	Version   string
	Kind      string
	Name      string
	Namespace string
}

type CredentialsRetriever

type CredentialsRetriever interface {
	Source() string
	RetrieveCredentials() ([]Credentials, error)
}

CredentialsRetriever defines the interface that adapters need to implement in order to retrieve CAPI credentials.

type Template

type Template struct {
	Name        string
	Description string
	Provider    string
	Error       string
}

type TemplateParameter

type TemplateParameter struct {
	Name        string
	Description string
	Required    bool
	Options     []string
}

type TemplatePullRequester

type TemplatePullRequester interface {
	CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams) (string, error)
}

TemplatePullRequester defines the interface that adapters need to implement in order to create a pull request from a CAPI template. Implementers should return the web URI of the pull request.

type TemplateRenderer

type TemplateRenderer interface {
	RenderTemplateWithParameters(name string, parameters map[string]string, creds Credentials) (string, error)
}

TemplateRenderer defines the interface that adapters need to implement in order to render a template populated with parameter values.

type TemplatesRetriever

type TemplatesRetriever interface {
	Source() string
	RetrieveTemplates() ([]Template, error)
	RetrieveTemplatesByProvider(provider string) ([]Template, error)
	RetrieveTemplateParameters(name string) ([]TemplateParameter, error)
}

TemplatesRetriever defines the interface that adapters need to implement in order to return an array of templates.