github

package
v0.0.0-...-0117b6e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Overview

Package github implements the methods to access resources from github

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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

Directories

Path Synopsis
Package privategithub deals with all the authorization invocations to access private github
Package privategithub deals with all the authorization invocations to access private github
githubclient
Package githubclient contains methods for interacting with git
Package githubclient contains methods for interacting with git
githubclient/mock
Package mock_githubclient contains methods to mock githubclient package
Package mock_githubclient contains methods to mock githubclient package

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL