templates

package
v0.8.1-rc.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2022 License: MPL-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// CAPI template
	CAPITemplateKind = "CAPITemplate"

	// TF template
	GitopsTemplateKind = "GitopsTemplate"
)

Variables

This section is empty.

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 template.

Types

type CreatePullRequestFromTemplateParams

type CreatePullRequestFromTemplateParams struct {
	GitProviderToken string
	TemplateName     string
	TemplateKind     string
	ParameterValues  map[string]string
	RepositoryURL    string
	HeadBranch       string
	BaseBranch       string
	Title            string
	Description      string
	CommitMessage    string
	Credentials      capi.Credentials
	ProfileValues    []capi.ProfileValues
}

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 template (e.g. CAPI template, TF-Controller template). Implementers should return the web URI of the pull request.

Jump to

Keyboard shortcuts

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