github

Documentation

Overview

Package github provides utilities for talking to github API.

Index

• Constants
• func NewFactory() assetsclient.Factory
• type GitConfig
  • func NewGitConfig() (GitConfig, error)

Constants

const (
	// EnvGitProvider is the provider name.
	EnvGitProvider = "GIT_PROVIDER"

	// EnvGitOrgName is the git org name.
	EnvGitOrgName = "GIT_ORG_NAME"

	// EnvGitRepositoryName is the repository name.
	EnvGitRepositoryName = "GIT_REPOSITORY_NAME"

	// EnvGitAccessToken used for accessing private repositories.
	EnvGitAccessToken = "GIT_ACCESS_TOKEN"
)

Functions

func NewFactory

func NewFactory() assetsclient.Factory

NewFactory returns a new factory for Github clients.

Types

type GitConfig

type GitConfig struct {
	GitProvider    string
	GitOrgName     string
	GitRepoName    string
	GitAccessToken string
}

GitConfig contains necessary data to connect to github.

func NewGitConfig

func NewGitConfig() (GitConfig, error)

NewGitConfig ensures the environment variables required for the operator to run are set. Returns false if any of the required environment variables are not set.