project

Documentation

Index

• type Project
  • func (p *Project) GetBaseDestination() string
  • func (p *Project) GetDfuIndexUrl() string
  • func (p *Project) GetSkipIfExists() *string
  • func (p *Project) GetTasks() ([]*runner.Task, error)
• type ProjectDfuReleaseAsset
• type ProjectLicense
• type ProjectPage
  • func (pp *ProjectPage) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (pp *ProjectPage) GetDestination() string
  • func (pp *ProjectPage) GetGenerator() (runner.Generator, error)
  • func (*ProjectPage) GetID() string
  • func (pp *ProjectPage) GetImmutable() bool
  • func (pp *ProjectPage) GetPaths() ([]string, error)
  • func (pp *ProjectPage) GetReader() (io.ReadCloser, error)

Types

type Project

type Project struct {
	Owner             string
	Repo              string
	Licenses          []*ProjectLicense
	ReleaseTagPattern string
	RollingTag        string

	Files []string

	GoImport string
	GoRepo   string
	GoSubdir string
	GoBranch string

	Toc bool

	Force             bool
	LocalDirectory    *string
	BaseDestination   string
	Template          string
	Immutable         bool
	OpenGraph         *opengraph.Config
	OpenGraphImageGen *opengraph.OpenGraphImageGen

	CDocsDestination   string
	CDocsHeaders       []string
	CDocsBaseDirectory *string
	CDocsTemplate      string
	CDocsOpenGraph     *opengraph.Config

	DfuDestination   string
	DfuReleaseAssets []*ProjectDfuReleaseAsset

	ForgejoUrl string
	// contains filtered or unexported fields
}

func (*Project) GetBaseDestination

func (p *Project) GetBaseDestination() string

func (*Project) GetDfuIndexUrl

func (p *Project) GetDfuIndexUrl() string

func (*Project) GetSkipIfExists

func (p *Project) GetSkipIfExists() *string

func (*Project) GetTasks

func (p *Project) GetTasks() ([]*runner.Task, error)

type ProjectDfuReleaseAsset

type ProjectDfuReleaseAsset struct {
	Pattern     string
	Description string
	// contains filtered or unexported fields
}

type ProjectLicense

type ProjectLicense struct {
	SpdxId string
	Title  string
}

type ProjectPage

type ProjectPage struct {
	// contains filtered or unexported fields
}

func (*ProjectPage) GetByProducts

func (pp *ProjectPage) GetByProducts(ch chan *runner.GeneratorByProduct)

func (*ProjectPage) GetDestination

func (pp *ProjectPage) GetDestination() string

func (*ProjectPage) GetGenerator

func (pp *ProjectPage) GetGenerator() (runner.Generator, error)

func (*ProjectPage) GetID

func (*ProjectPage) GetID() string

func (*ProjectPage) GetImmutable

func (pp *ProjectPage) GetImmutable() bool

func (*ProjectPage) GetPaths

func (pp *ProjectPage) GetPaths() ([]string, error)

func (*ProjectPage) GetReader

func (pp *ProjectPage) GetReader() (io.ReadCloser, error)