gitresource

Documentation

Overview

Package gitresource implements the methods to access resources from git

Index

• type GitInfo
• type GitResource
  • func NewGitResource(log log.T, info string, token privategithub.PrivateGithubAccess) (git *GitResource, err error)
  • func (git *GitResource) DownloadRemoteResource(log log.T, filesys filemanager.FileSystem, destPath string) (err error, result *remoteresource.DownloadResult)
  • func (git *GitResource) ValidateLocationInfo() (valid bool, err error)

Types

type GitInfo

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

GitInfo represents the sourceInfo type sent by runcommand

type GitResource

type GitResource struct {
	Info GitInfo
	// contains filtered or unexported fields
}

GitResource is a struct for the remote resource of type git

func NewGitResource

func NewGitResource(log log.T, info string, token privategithub.PrivateGithubAccess) (git *GitResource, err error)

NewGitResource is a constructor of type GitResource

func (*GitResource) DownloadRemoteResource

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

DownloadRemoteResource calls download to pull down files or directory from github

func (*GitResource) ValidateLocationInfo

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

ValidateLocationInfo ensures that the required parameters of SourceInfo are specified