github

Documentation

Index

• Constants
• func ErrGenerateGitHubPackage(err error, pkgName string) error
• func ErrInvalidGitHubSourceURL(err error) error
• func ProcessContent(w io.Writer, downloadDirPath, downloadfilePath string) error
• type DownloaderScheme
  • func NewDownloaderForScheme(scheme string, url *url.URL, packageName string) DownloaderScheme
• type GitHubPackage
  • func (gp GitHubPackage) GenerateComponents() ([]_component.ComponentDefinition, error)
  • func (gp GitHubPackage) GetName() string
  • func (gp GitHubPackage) GetSourceURL() string
  • func (gp GitHubPackage) GetVersion() string
• type GitHubPackageManager
  • func (ghpm GitHubPackageManager) GetPackage() (models.Package, error)
• type GitRepo
  • func (gr GitRepo) ExtractRepoDetailsFromSourceURL() (owner, repo, branch, root string, err error)
  • func (gr GitRepo) GetContent() (models.Package, error)
• type URL
  • func (u URL) GetContent() (models.Package, error)

Constants

const (
	ErrGenerateGitHubPackageCode  = "meshkit-11139"
	ErrInvalidGitHubSourceURLCode = "meshkit-11140"
)

const (
	GitHub = "github"
)

Functions

func ErrGenerateGitHubPackage

func ErrGenerateGitHubPackage(err error, pkgName string) error

func ErrInvalidGitHubSourceURL

func ErrInvalidGitHubSourceURL(err error) error

func ProcessContent

func ProcessContent(w io.Writer, downloadDirPath, downloadfilePath string) error

Types

type DownloaderScheme

type DownloaderScheme interface {
	GetContent() (models.Package, error)
}

func NewDownloaderForScheme

func NewDownloaderForScheme(scheme string, url *url.URL, packageName string) DownloaderScheme

type GitHubPackage

type GitHubPackage struct {
	Name string `yaml:"name" json:"name"`

	SourceURL string `yaml:"source_url" json:"source_url"`
	// contains filtered or unexported fields
}

func (GitHubPackage) GenerateComponents

func (gp GitHubPackage) GenerateComponents() ([]_component.ComponentDefinition, error)

func (GitHubPackage) GetName

func (gp GitHubPackage) GetName() string

func (GitHubPackage) GetSourceURL

func (gp GitHubPackage) GetSourceURL() string

func (GitHubPackage) GetVersion

func (gp GitHubPackage) GetVersion() string

type GitHubPackageManager

type GitHubPackageManager struct {
	PackageName string
	SourceURL   string
}

func (GitHubPackageManager) GetPackage

func (ghpm GitHubPackageManager) GetPackage() (models.Package, error)

type GitRepo

type GitRepo struct {
	// <git://github.com/owner/repo/branch/versiontag/root(path to the directory/file)>
	URL         *url.URL
	PackageName string
}

func (GitRepo) ExtractRepoDetailsFromSourceURL

func (gr GitRepo) ExtractRepoDetailsFromSourceURL() (owner, repo, branch, root string, err error)

func (GitRepo) GetContent

func (gr GitRepo) GetContent() (models.Package, error)

type URL

type URL struct {
	URL         *url.URL
	PackageName string
}

func (URL) GetContent

func (u URL) GetContent() (models.Package, error)