lib

Documentation

Index

• func DownloadDirectory(ctx context.Context, scmType SCMType, ...) error
• func GetRepositories(ctx context.Context, scmType SCMType, baseURL, owner string) ([]string, error)
• type Catalog
  • func FetchGitspaceCatalog(ctx context.Context, scmType SCMType, baseURL, owner, repo string) (*Catalog, error)
• type GitHubProvider
  • func NewGitHubProvider() (*GitHubProvider, error)
  • func (g *GitHubProvider) DownloadDirectory(ctx context.Context, owner, repo, path, destDir string) error
  • func (g *GitHubProvider) FetchCatalog(ctx context.Context, owner, repo string) (*Catalog, error)
  • func (g *GitHubProvider) FetchRepositories(ctx context.Context, owner string) ([]string, error)
  • func (g *GitHubProvider) GetLatestRelease(ctx context.Context, owner, repo string) (*Release, error)
• type GiteaProvider
  • func NewGiteaProvider(baseURL string) (*GiteaProvider, error)
  • func (g *GiteaProvider) DownloadDirectory(ctx context.Context, owner, repo, path, destDir string) error
  • func (g *GiteaProvider) FetchCatalog(ctx context.Context, owner, repo string) (*Catalog, error)
  • func (g *GiteaProvider) FetchRepositories(ctx context.Context, owner string) ([]string, error)
  • func (g *GiteaProvider) GetLatestRelease(ctx context.Context, owner, repo string) (*Release, error)
• type Plugin
• type Release
  • func GetLatestRelease(ctx context.Context, scmType SCMType, baseURL, owner, repo string) (*Release, error)
• type SCMProvider
  • func GetSCMProvider(scmType SCMType, baseURL string) (SCMProvider, error)
• type SCMType
• type Template

Functions

func DownloadDirectory

func DownloadDirectory(ctx context.Context, scmType SCMType, baseURL, owner, repo, path, destDir string) error

func GetRepositories

func GetRepositories(ctx context.Context, scmType SCMType, baseURL, owner string) ([]string, error)

Types

type Catalog

type Catalog struct {
	Catalog struct {
		Name        string `toml:"name"`
		Description string `toml:"description"`
		Version     string `toml:"version"`
		LastUpdated struct {
			Date       string `toml:"date"`
			CommitHash string `toml:"commit_hash"`
		} `toml:"last_updated"`
	} `toml:"catalog"`
	Plugins   map[string]Plugin   `toml:"plugins"`
	Templates map[string]Template `toml:"templates"`
}

func FetchGitspaceCatalog

func FetchGitspaceCatalog(ctx context.Context, scmType SCMType, baseURL, owner, repo string) (*Catalog, error)

type GitHubProvider

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

func NewGitHubProvider

func NewGitHubProvider() (*GitHubProvider, error)

func (*GitHubProvider) DownloadDirectory

func (g *GitHubProvider) DownloadDirectory(ctx context.Context, owner, repo, path, destDir string) error

func (*GitHubProvider) FetchCatalog

func (g *GitHubProvider) FetchCatalog(ctx context.Context, owner, repo string) (*Catalog, error)

func (*GitHubProvider) FetchRepositories

func (g *GitHubProvider) FetchRepositories(ctx context.Context, owner string) ([]string, error)

func (*GitHubProvider) GetLatestRelease

func (g *GitHubProvider) GetLatestRelease(ctx context.Context, owner, repo string) (*Release, error)

type GiteaProvider

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

func NewGiteaProvider

func NewGiteaProvider(baseURL string) (*GiteaProvider, error)

func (*GiteaProvider) DownloadDirectory

func (g *GiteaProvider) DownloadDirectory(ctx context.Context, owner, repo, path, destDir string) error

func (*GiteaProvider) FetchCatalog

func (g *GiteaProvider) FetchCatalog(ctx context.Context, owner, repo string) (*Catalog, error)

func (*GiteaProvider) FetchRepositories

func (g *GiteaProvider) FetchRepositories(ctx context.Context, owner string) ([]string, error)

func (*GiteaProvider) GetLatestRelease

func (g *GiteaProvider) GetLatestRelease(ctx context.Context, owner, repo string) (*Release, error)

type Plugin

type Plugin struct {
	Version     string `toml:"version"`
	Description string `toml:"description"`
	Path        string `toml:"path"`
	Repository  struct {
		Type string `toml:"type"`
		URL  string `toml:"url"`
	} `toml:"repository"`
}

type Release

type Release struct {
	TagName     string    `json:"tag_name"`
	PublishedAt time.Time `json:"published_at"`
	Body        string    `json:"body"`
}

func GetLatestRelease

func GetLatestRelease(ctx context.Context, scmType SCMType, baseURL, owner, repo string) (*Release, error)

type SCMProvider

type SCMProvider interface {
	GetLatestRelease(ctx context.Context, owner, repo string) (*Release, error)
	FetchRepositories(ctx context.Context, owner string) ([]string, error)
	FetchCatalog(ctx context.Context, owner, repo string) (*Catalog, error)
	DownloadDirectory(ctx context.Context, owner, repo, path, destDir string) error
}

func GetSCMProvider

func GetSCMProvider(scmType SCMType, baseURL string) (SCMProvider, error)

type SCMType

type SCMType string

const (
	SCMTypeGitHub SCMType = "github"
	SCMTypeGitea  SCMType = "gitea"
)

type Template

type Template struct {
	Version     string `toml:"version,omitempty"`
	Description string `toml:"description,omitempty"`
	Path        string `toml:"path"`
	Repository  struct {
		Type string `toml:"type"`
		URL  string `toml:"url"`
	} `toml:"repository"`
}