gitproviders

Documentation

Index

• Variables
• func NewOrgRepositoryRef(domain, org, repoName string) gitprovider.OrgRepositoryRef
• func ViperGetStringMapString(key string) map[string]string
• type AccountTypeGetter
• type Client
• type Config
• type GitProvider
  • func New(config Config, owner string, getAccountType AccountTypeGetter) (GitProvider, error)
  • func NewDryRun() (GitProvider, error)
• type GitProviderName
• type ProviderAccountType
  • func GetAccountType(provider gitprovider.Client, domain string, owner string) (ProviderAccountType, error)
• type PullRequestInfo
• type RepoURL
  • func NewRepoURL(uri string) (RepoURL, error)
  • func (n RepoURL) Owner() string
  • func (n RepoURL) Protocol() RepositoryURLProtocol
  • func (n RepoURL) Provider() GitProviderName
  • func (n RepoURL) RepositoryName() string
  • func (n RepoURL) String() string
  • func (n RepoURL) URL() *url.URL
• type RepositoryURLProtocol

Variables

var ErrRepositoryNoPermissionsOrDoesNotExist = errors.New("no permissions to access this repository or repository doesn't exists")

Functions

func NewOrgRepositoryRef

func NewOrgRepositoryRef(domain, org, repoName string) gitprovider.OrgRepositoryRef

func ViperGetStringMapString

func ViperGetStringMapString(key string) map[string]string

ViperGetStringMapString looks up a command line flag or env var in the format "foo=1,bar=2" GetStringMapString tries to JSON decode the env var If that fails (silently), try and decode the classic "foo=1,bar=2" form. https://github.com/spf13/viper/issues/911

Types

type AccountTypeGetter

type AccountTypeGetter func(provider gitprovider.Client, domain string, owner string) (ProviderAccountType, error)

type Client

type Client interface {
	GetProvider(repoURL RepoURL, getAccountType AccountTypeGetter) (GitProvider, error)
}

type Config

type Config struct {
	// Provider defines the GitProvider.
	Provider GitProviderName

	// Hostname is the HTTP/S hostname of the Provider,
	// e.g. github.example.com.
	Hostname string

	// Token contains the token used to authenticate with the
	// Provider.
	Token string
}

Config defines the configuration for connecting to a GitProvider.

type GitProvider

type GitProvider interface {
	RepositoryExists(ctx context.Context, repoURL RepoURL) (bool, error)
	DeployKeyExists(ctx context.Context, repoURL RepoURL) (bool, error)
	GetDefaultBranch(ctx context.Context, repoURL RepoURL) (string, error)
	GetRepoVisibility(ctx context.Context, repoURL RepoURL) (*gitprovider.RepositoryVisibility, error)
	UploadDeployKey(ctx context.Context, repoURL RepoURL, deployKey []byte) error
	CreatePullRequest(ctx context.Context, repoURL RepoURL, prInfo PullRequestInfo) (gitprovider.PullRequest, error)
	GetCommits(ctx context.Context, repoURL RepoURL, targetBranch string, pageSize int, pageToken int) ([]gitprovider.Commit, error)
	GetProviderDomain() string
	GetRepoDirFiles(ctx context.Context, repoURL RepoURL, dirPath, targetBranch string) ([]*gitprovider.CommitFile, error)
	MergePullRequest(ctx context.Context, repoURL RepoURL, pullRequestNumber int, commitMesage string) error
}

GitProvider Handler

func New

func New(config Config, owner string, getAccountType AccountTypeGetter) (GitProvider, error)

func NewDryRun

func NewDryRun() (GitProvider, error)

type GitProviderName

type GitProviderName string

GitProviderName holds a Git provider definition.

const (
	GitProviderGitHub GitProviderName = "github"
	GitProviderGitLab GitProviderName = "gitlab"
)

type ProviderAccountType

type ProviderAccountType string

const (
	AccountTypeUser ProviderAccountType = "user"
	AccountTypeOrg  ProviderAccountType = "organization"
	DeployKeyName                       = "wego-deploy-key"
)

func GetAccountType

func GetAccountType(provider gitprovider.Client, domain string, owner string) (ProviderAccountType, error)

type PullRequestInfo

type PullRequestInfo struct {
	Title                     string
	Description               string
	CommitMessage             string
	TargetBranch              string
	NewBranch                 string
	SkipAddingFilesOnCreation bool
	Files                     []gitprovider.CommitFile
}

type RepoURL

type RepoURL struct {
	// contains filtered or unexported fields
}

func NewRepoURL

func NewRepoURL(uri string) (RepoURL, error)

func (RepoURL) Owner

func (n RepoURL) Owner() string

func (RepoURL) Protocol

func (n RepoURL) Protocol() RepositoryURLProtocol

func (RepoURL) Provider

func (n RepoURL) Provider() GitProviderName

func (RepoURL) RepositoryName

func (n RepoURL) RepositoryName() string

func (RepoURL) String

func (n RepoURL) String() string

func (RepoURL) URL

func (n RepoURL) URL() *url.URL

type RepositoryURLProtocol

type RepositoryURLProtocol string

const RepositoryURLProtocolHTTPS RepositoryURLProtocol = "https"

const RepositoryURLProtocolSSH RepositoryURLProtocol = "ssh"