github

Documentation

Overview

Package github implements the methods to access resources from github

Index

• type GitHubInfo
• type GitHubResource
  • func NewGitHubResource(context context.T, info string, token privategithub.PrivateGithubAccess) (git *GitHubResource, err error)
  • func (git *GitHubResource) DownloadRemoteResource(filesys filemanager.FileSystem, destPath string) (err error, result *remoteresource.DownloadResult)
  • func (git *GitHubResource) ValidateLocationInfo() (valid bool, err error)

Types

type GitHubInfo

type GitHubInfo struct {
	Owner      string `json:"owner"`
	Repository string `json:"repository"`
	Path       string `json:"path"`
	GetOptions string `json:"getOptions"`
	TokenInfo  string `json:"tokenInfo"`
}

GitHubInfo represents the sourceInfo type sent by runcommand

type GitHubResource

type GitHubResource struct {
	Info GitHubInfo
	// contains filtered or unexported fields
}

GitHubResource is a struct for the remote resource of type git

func NewGitHubResource

func NewGitHubResource(context context.T, info string, token privategithub.PrivateGithubAccess) (git *GitHubResource, err error)

NewGitHubResource is a constructor of type GitHubResource

func (*GitHubResource) DownloadRemoteResource

func (git *GitHubResource) DownloadRemoteResource(filesys filemanager.FileSystem, destPath string) (err error, result *remoteresource.DownloadResult)

DownloadRemoteResource calls download to pull down files or directory from github

func (*GitHubResource) ValidateLocationInfo

func (git *GitHubResource) ValidateLocationInfo() (valid bool, err error)

ValidateLocationInfo ensures that the required parameters of SourceInfo are specified