github

package

v0.0.0-...-6542a44 Latest Latest Go to latest Published: Nov 4, 2017 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/steadyequipment/goutility

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CreateFile(client *github.Client, repository *github.Repository, path string, ...) (*github.RepositoryContentResponse, error)
func CreateOrUpdateFile(client *github.Client, repository *github.Repository, path string, ...) (*github.RepositoryContentResponse, error)
func FindRepoByOrg(client *github.Client, orgName string, repoName string) (*github.Repository, error)
func GetFileContents(client *github.Client, repository *github.Repository, path string) (*github.RepositoryContent, error)
func MakeClientWithOauth2StaticToken(accessToken string) *github.Client
func TestCreateFile(t *testing.T)
func TestCreateFile_existing(t *testing.T)
func TestCreateOrUpdateFile_create(t *testing.T)
func TestCreateOrUpdateFile_update(t *testing.T)
func TestFindRepoByOrg(t *testing.T)
func TestFindRepoByOrg_invalid(t *testing.T)
func TestGetContents(t *testing.T)
func TestGetContents_invalid(t *testing.T)
func TestMakeClientWithOauth2StaticToken(t *testing.T)
func TestUpdateFile(t *testing.T)
func UpdateFile(client *github.Client, repository *github.Repository, path string, ...) (*github.RepositoryContentResponse, error)
type ListingReposInOrgError
- func MakeListingReposInOrgError(orgName string, underlyingError error) ListingReposInOrgError
- func (this ListingReposInOrgError) OrgName() string
- func (this ListingReposInOrgError) UnderlyingError() error
type NoClientProvidedError
- func MakeNoClientProvidedError() NoClientProvidedError
type NoOptionsProvidedError
- func MakeNoOptionsProvidedError() NoOptionsProvidedError
type NoRepoProvidedError
- func MakeNoRepoProvidedError() NoRepoProvidedError
type PathIsNotAFileIsADirectoryError
- func MakeNotAFileIsADirectoryError(path string) PathIsNotAFileIsADirectoryError
- func (this PathIsNotAFileIsADirectoryError) Path() string
type UnableToDetermineStatusOfFileError
- func MakeUnableToDetermineStatusOfFileError(path string) UnableToDetermineStatusOfFileError
- func (this UnableToDetermineStatusOfFileError) Path() string
type UnableToFindRepoError
- func MakeUnableToFindRepoError(orgName string, repoName string) UnableToFindRepoError
- func (this UnableToFindRepoError) OrgName() string
- func (this UnableToFindRepoError) RepoName() string

Constants ¶

View Source

const (
	CodeContext = "goutility/github"

	NoClientProvidedCode goutility.ErrorCode = 1 << iota
	ListingReposInOrgCode

	NoRepoProvidedCode

	PathIsNotAFileIsADirectoryCode

	NoOptionsProvidedCode

	UnableToDetermineStatusOfFileCode
)

Variables ¶

This section is empty.

Functions ¶

func CreateFile ¶

func CreateFile(client *github.Client, repository *github.Repository, path string, options *github.RepositoryContentFileOptions) (*github.RepositoryContentResponse, error)

func CreateOrUpdateFile ¶

func CreateOrUpdateFile(client *github.Client, repository *github.Repository, path string, options *github.RepositoryContentFileOptions) (*github.RepositoryContentResponse, error)

func FindRepoByOrg ¶

func FindRepoByOrg(client *github.Client, orgName string, repoName string) (*github.Repository, error)

func GetFileContents ¶

func GetFileContents(client *github.Client, repository *github.Repository, path string) (*github.RepositoryContent, error)

func MakeClientWithOauth2StaticToken ¶

func MakeClientWithOauth2StaticToken(accessToken string) *github.Client

func TestCreateFile ¶

func TestCreateFile(t *testing.T)

func TestCreateFile_existing ¶

func TestCreateFile_existing(t *testing.T)

func TestCreateOrUpdateFile_create ¶

func TestCreateOrUpdateFile_create(t *testing.T)

func TestCreateOrUpdateFile_update ¶

func TestCreateOrUpdateFile_update(t *testing.T)

func TestFindRepoByOrg ¶

func TestFindRepoByOrg(t *testing.T)

func TestFindRepoByOrg_invalid ¶

func TestFindRepoByOrg_invalid(t *testing.T)

func TestGetContents ¶

func TestGetContents(t *testing.T)

func TestGetContents_invalid ¶

func TestGetContents_invalid(t *testing.T)

func TestMakeClientWithOauth2StaticToken ¶

func TestMakeClientWithOauth2StaticToken(t *testing.T)

func TestUpdateFile ¶

func TestUpdateFile(t *testing.T)

func UpdateFile ¶

func UpdateFile(client *github.Client, repository *github.Repository, path string, options *github.RepositoryContentFileOptions) (*github.RepositoryContentResponse, error)

Types ¶

type ListingReposInOrgError ¶

type ListingReposInOrgError struct {
	goutility.ErrorType
	// contains filtered or unexported fields
}

region Listing Repos In Org

func MakeListingReposInOrgError ¶

func MakeListingReposInOrgError(orgName string, underlyingError error) ListingReposInOrgError

func (ListingReposInOrgError) OrgName ¶

func (this ListingReposInOrgError) OrgName() string

func (ListingReposInOrgError) UnderlyingError ¶

func (this ListingReposInOrgError) UnderlyingError() error

type NoClientProvidedError ¶

type NoClientProvidedError struct {
	goutility.ErrorType
}

region No Client Provided

func MakeNoClientProvidedError ¶

func MakeNoClientProvidedError() NoClientProvidedError

type NoOptionsProvidedError ¶

type NoOptionsProvidedError struct {
	goutility.ErrorType
}

region No Options Provided

func MakeNoOptionsProvidedError ¶

func MakeNoOptionsProvidedError() NoOptionsProvidedError

type NoRepoProvidedError ¶

type NoRepoProvidedError struct {
	goutility.ErrorType
}

region No Repo Provided

func MakeNoRepoProvidedError ¶

func MakeNoRepoProvidedError() NoRepoProvidedError

type PathIsNotAFileIsADirectoryError ¶

type PathIsNotAFileIsADirectoryError struct {
	goutility.ErrorType
	// contains filtered or unexported fields
}

region Path Is Not A File Is A Directory

func MakeNotAFileIsADirectoryError ¶

func MakeNotAFileIsADirectoryError(path string) PathIsNotAFileIsADirectoryError

func (PathIsNotAFileIsADirectoryError) Path ¶

func (this PathIsNotAFileIsADirectoryError) Path() string

type UnableToDetermineStatusOfFileError ¶

type UnableToDetermineStatusOfFileError struct {
	goutility.ErrorType
	// contains filtered or unexported fields
}

region Unable To Determine Status of File

func MakeUnableToDetermineStatusOfFileError ¶

func MakeUnableToDetermineStatusOfFileError(path string) UnableToDetermineStatusOfFileError

func (UnableToDetermineStatusOfFileError) Path ¶

func (this UnableToDetermineStatusOfFileError) Path() string

type UnableToFindRepoError ¶

type UnableToFindRepoError struct {
	goutility.ErrorType
	// contains filtered or unexported fields
}

region Unable To Find Repo

func MakeUnableToFindRepoError ¶

func MakeUnableToFindRepoError(orgName string, repoName string) UnableToFindRepoError

func (UnableToFindRepoError) OrgName ¶

func (this UnableToFindRepoError) OrgName() string

func (UnableToFindRepoError) RepoName ¶

func (this UnableToFindRepoError) RepoName() string

Source Files ¶

View all Source files

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