quickstarts

Documentation

Index

• Constants
• type Quickstart
  • func GitQuickstart(provider gits.GitProvider, owner string, repo string, language string, ...) *Quickstart
  • func (q *Quickstart) SurveyName() string
• type QuickstartFilter
  • func (f *QuickstartFilter) Matches(q *Quickstart) bool
• type QuickstartForm
• type QuickstartModel
  • func NewQuickstartModel() *QuickstartModel
  • func (model *QuickstartModel) Add(q *Quickstart) bool
  • func (model *QuickstartModel) CreateSurvey(filter *QuickstartFilter, batchMode bool, in terminal.FileReader, ...) (*QuickstartForm, error)
  • func (model *QuickstartModel) Filter(filter *QuickstartFilter) []*Quickstart
  • func (model *QuickstartModel) Languages() []string
  • func (model *QuickstartModel) LoadGithubQuickstarts(provider gits.GitProvider, owner string, includes []string, excludes []string) error

Constants

const (
	// JenkinsXQuickstartsOwner default quickstart owner
	JenkinsXQuickstartsOwner = "jenkins-x-quickstarts"
)

Types

type Quickstart

type Quickstart struct {
	ID             string
	Owner          string
	Name           string
	Language       string
	Framework      string
	Tags           []string
	DownloadZipURL string
	GitProvider    gits.GitProvider
}

func GitQuickstart

func GitQuickstart(provider gits.GitProvider, owner string, repo string, language string, framework string, tags ...string) *Quickstart

GitQuickstart returns a github based quickstart

func (*Quickstart) SurveyName

func (q *Quickstart) SurveyName() string

type QuickstartFilter

type QuickstartFilter struct {
	Language    string
	Framework   string
	Owner       string
	Text        string
	ProjectName string
	Tags        []string
}

func (*QuickstartFilter) Matches

func (f *QuickstartFilter) Matches(q *Quickstart) bool

type QuickstartForm

type QuickstartForm struct {
	Quickstart *Quickstart
	Name       string
}

type QuickstartModel

type QuickstartModel struct {
	Quickstarts map[string]*Quickstart
}

func NewQuickstartModel

func NewQuickstartModel() *QuickstartModel

NewQuickstartModel creates a new quickstart model

func (*QuickstartModel) Add

func (model *QuickstartModel) Add(q *Quickstart) bool

Add adds the given quickstart to this mode. Returns true if it was added

func (*QuickstartModel) CreateSurvey

func (model *QuickstartModel) CreateSurvey(filter *QuickstartFilter, batchMode bool, in terminal.FileReader, out terminal.FileWriter, errOut io.Writer) (*QuickstartForm, error)

CreateSurvey creates a survey to query pick a quickstart

func (*QuickstartModel) Filter

func (model *QuickstartModel) Filter(filter *QuickstartFilter) []*Quickstart

Filter filters all the available quickstarts with the filter and return the matches

func (*QuickstartModel) Languages

func (model *QuickstartModel) Languages() []string

Languages returns all the languages in the quickstarts sorted

func (*QuickstartModel) LoadGithubQuickstarts

func (model *QuickstartModel) LoadGithubQuickstarts(provider gits.GitProvider, owner string, includes []string, excludes []string) error

LoadGithubQuickstarts Loads quickstarts from github