contentprovider

Documentation

Index

• Constants
• type GitHub
  • func NewGitHub(remoteURI string) (*GitHub, error)
  • func (cp *GitHub) Cleanup() error
  • func (cp *GitHub) DownloadContent() error
  • func (cp *GitHub) RemoteURI() string
  • func (cp *GitHub) WorkingDir() string
• type GitLab
  • func NewGitLab(remoteURI string, opt ...GitLabOption) (*GitLab, error)
  • func (cp *GitLab) Cleanup() error
  • func (cp *GitLab) DownloadContent() error
  • func (cp *GitLab) RemoteURI() string
  • func (cp *GitLab) WorkingDir() string
• type GitLabOption
  • func WithHTTPClient(httpClient *http.Client) GitLabOption
• type LocalPath
  • func NewLocalPath(path string) (*LocalPath, error)
  • func (cp *LocalPath) Cleanup() error
  • func (cp *LocalPath) DownloadContent() error
  • func (cp *LocalPath) RemoteURI() string
  • func (cp *LocalPath) WorkingDir() string
• type RemoteContentProvider
  • func ByURI(uri string) (RemoteContentProvider, error)

Constants

const GitHubPrefix = "https://github.com/"

const GitLabPrefix = "https://gitlab.com/"

const LocalPathPrefix = "file://"

Types

type GitHub

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

func NewGitHub

func NewGitHub(remoteURI string) (*GitHub, error)

func (*GitHub) Cleanup

func (cp *GitHub) Cleanup() error

func (*GitHub) DownloadContent

func (cp *GitHub) DownloadContent() error

func (*GitHub) RemoteURI

func (cp *GitHub) RemoteURI() string

func (*GitHub) WorkingDir

func (cp *GitHub) WorkingDir() string

type GitLab

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

func NewGitLab

func NewGitLab(remoteURI string, opt ...GitLabOption) (*GitLab, error)

func (*GitLab) Cleanup

func (cp *GitLab) Cleanup() error

func (*GitLab) DownloadContent

func (cp *GitLab) DownloadContent() error

func (*GitLab) RemoteURI

func (cp *GitLab) RemoteURI() string

func (*GitLab) WorkingDir

func (cp *GitLab) WorkingDir() string

type GitLabOption

type GitLabOption func(*GitLab)

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) GitLabOption

type LocalPath

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

func NewLocalPath

func NewLocalPath(path string) (*LocalPath, error)

func (*LocalPath) Cleanup

func (cp *LocalPath) Cleanup() error

func (*LocalPath) DownloadContent

func (cp *LocalPath) DownloadContent() error

func (*LocalPath) RemoteURI

func (cp *LocalPath) RemoteURI() string

func (*LocalPath) WorkingDir

func (cp *LocalPath) WorkingDir() string

type RemoteContentProvider

type RemoteContentProvider interface {
	// DownloadContent Download the remote content to a local working directory
	DownloadContent() error
	// Cleanup Perform the cleanup task for the provider
	Cleanup() error
	// WorkingDir Get the local working directory
	WorkingDir() string
	// RemoteURI Get the remote URI
	RemoteURI() string
}

func ByURI

func ByURI(uri string) (RemoteContentProvider, error)