Documentation ¶
Index ¶
- Constants
- func ConvertToValidBranchName(name string) string
- func DiscoverRemoteGitURL(gitConf string) (string, error)
- func FindGitConfigDir(dir string) (string, string, error)
- func GetGitServer(dir string) (string, error)
- func GetRemoteUrl(config *gitcfg.Config, name string) string
- func GitAdd(dir string, args ...string) error
- func GitClone(url string, directory string) error
- func GitCmd(dir string, args ...string) error
- func GitCommit(dir string, message string) error
- func GitCommitIfChanges(dir string, message string) error
- func GitCreatePushURL(cloneURL string, userAuth *auth.UserAuth) (string, error)
- func GitGetBranch(dir string) (string, error)
- func GitGetRemoteBranchNames(dir string, prefix string) ([]string, error)
- func GitHubAccessTokenURL(url string) string
- func GitInit(dir string) error
- func GitPush(dir string) error
- func GitRepoName(org, repoName string) string
- func GitStatus(dir string) error
- func GiteaAccessTokenURL(url string) string
- func HasChanges(dir string) (bool, error)
- func IsGitRepoStatusFailed(statuses ...*GitRepoStatus) bool
- func IsGitRepoStatusSuccess(statuses ...*GitRepoStatus) bool
- func PickOrganisation(provider GitProvider, userName string) (string, error)
- func PrintCreateRepositoryGenerateAccessToken(server *auth.AuthServer, o io.Writer)
- func ProviderAccessTokenURL(kind string, url string) string
- func SetRemoteURL(dir string, name string, gitURL string) error
- type CreateRepoData
- type GitHubProvider
- func (p *GitHubProvider) CreatePullRequest(data *GitPullRequestArguments) (*GitPullRequest, error)
- func (p *GitHubProvider) CreateRepository(org string, name string, private bool) (*GitRepository, error)
- func (p *GitHubProvider) CreateWebHook(data *GitWebHookArguments) error
- func (p *GitHubProvider) DeleteRepository(org string, name string) error
- func (p *GitHubProvider) ForkRepository(originalOrg string, name string, destinationOrg string) (*GitRepository, error)
- func (p *GitHubProvider) GetRepository(org string, name string) (*GitRepository, error)
- func (p *GitHubProvider) IsGitHub() bool
- func (p *GitHubProvider) JenkinsWebHookPath(gitURL string, secret string) string
- func (p *GitHubProvider) Label() string
- func (p *GitHubProvider) ListCommitStatus(org string, repo string, sha string) ([]*GitRepoStatus, error)
- func (p *GitHubProvider) ListOrganisations() ([]GitOrganisation, error)
- func (p *GitHubProvider) ListRepositories(org string) ([]*GitRepository, error)
- func (p *GitHubProvider) MergePullRequest(pr *GitPullRequest, message string) error
- func (p *GitHubProvider) PullRequestLastCommitStatus(pr *GitPullRequest) (string, error)
- func (p *GitHubProvider) RenameRepository(org string, name string, newName string) (*GitRepository, error)
- func (p *GitHubProvider) UpdatePullRequestStatus(pr *GitPullRequest) error
- func (p *GitHubProvider) ValidateRepositoryName(org string, name string) error
- type GitOrganisation
- type GitProvider
- type GitPullRequest
- type GitPullRequestArguments
- type GitRepoStatus
- type GitRepository
- type GitRepositoryInfo
- func (i *GitRepositoryInfo) CreateProviderForUser(server *auth.AuthServer, user *auth.UserAuth) (GitProvider, error)
- func (i *GitRepositoryInfo) HttpCloneURL() string
- func (i *GitRepositoryInfo) IsGitHub() bool
- func (i *GitRepositoryInfo) PickOrCreateProvider(authConfigSvc auth.AuthConfigService, message string, batchMode bool) (GitProvider, error)
- func (i *GitRepositoryInfo) PullRequestURL(prName string) string
- type GitRepositoryOptions
- type GitWebHookArguments
- type GiteaProvider
- func (p *GiteaProvider) CreatePullRequest(data *GitPullRequestArguments) (*GitPullRequest, error)
- func (p *GiteaProvider) CreateRepository(org string, name string, private bool) (*GitRepository, error)
- func (p *GiteaProvider) CreateWebHook(data *GitWebHookArguments) error
- func (p *GiteaProvider) DeleteRepository(org string, name string) error
- func (p *GiteaProvider) ForkRepository(originalOrg string, name string, destinationOrg string) (*GitRepository, error)
- func (p *GiteaProvider) GetRepository(org string, name string) (*GitRepository, error)
- func (p *GiteaProvider) IsGitHub() bool
- func (p *GiteaProvider) JenkinsWebHookPath(gitURL string, secret string) string
- func (p *GiteaProvider) Label() string
- func (p *GiteaProvider) ListCommitStatus(org string, repo string, sha string) ([]*GitRepoStatus, error)
- func (p *GiteaProvider) ListOrganisations() ([]GitOrganisation, error)
- func (p *GiteaProvider) ListRepositories(org string) ([]*GitRepository, error)
- func (p *GiteaProvider) MergePullRequest(pr *GitPullRequest, message string) error
- func (p *GiteaProvider) PullRequestLastCommitStatus(pr *GitPullRequest) (string, error)
- func (p *GiteaProvider) RenameRepository(org string, name string, newName string) (*GitRepository, error)
- func (p *GiteaProvider) UpdatePullRequestStatus(pr *GitPullRequest) error
- func (p *GiteaProvider) ValidateRepositoryName(org string, name string) error
Constants ¶
const (
GitHubHost = "github.com"
)
Variables ¶
This section is empty.
Functions ¶
func ConvertToValidBranchName ¶
ConvertToValidBranchName converts the given branch name into a valid git branch string replacing any dodgy characters
func DiscoverRemoteGitURL ¶ added in v1.0.13
func FindGitConfigDir ¶
FindGitConfigDir tries to find the `.git` directory either in the current directory or in parent directories
func GetGitServer ¶ added in v1.0.74
func GitCommitIfChanges ¶
func GitCreatePushURL ¶
GitCreatePushURL creates the git repository URL with the username and password encoded for HTTPS based URLs
func GitGetBranch ¶ added in v1.0.83
func GitGetRemoteBranchNames ¶ added in v1.0.14
func GitHubAccessTokenURL ¶ added in v1.0.16
func GitRepoName ¶
func GiteaAccessTokenURL ¶ added in v1.0.16
func HasChanges ¶
func IsGitRepoStatusFailed ¶ added in v1.0.80
func IsGitRepoStatusFailed(statuses ...*GitRepoStatus) bool
IsGitRepoStatusFailed returns true if any of the statuses have failed
func IsGitRepoStatusSuccess ¶ added in v1.0.80
func IsGitRepoStatusSuccess(statuses ...*GitRepoStatus) bool
IsGitRepoStatusSuccess returns true if all the statuses are successful
func PickOrganisation ¶
func PickOrganisation(provider GitProvider, userName string) (string, error)
PickOrganisation picks an organisations login if there is one available
func PrintCreateRepositoryGenerateAccessToken ¶ added in v1.0.40
func PrintCreateRepositoryGenerateAccessToken(server *auth.AuthServer, o io.Writer)
func ProviderAccessTokenURL ¶ added in v1.0.16
Types ¶
type CreateRepoData ¶
type CreateRepoData struct { Organisation string RepoName string FullName string PrivateRepo bool User *auth.UserAuth GitProvider GitProvider }
func PickNewGitRepository ¶
func PickNewGitRepository(out io.Writer, batchMode bool, authConfigSvc auth.AuthConfigService, defaultRepoName string, repoOptions GitRepositoryOptions) (*CreateRepoData, error)
func (*CreateRepoData) CreateRepository ¶
func (d *CreateRepoData) CreateRepository() (*GitRepository, error)
CreateRepository creates the repository - failing if it already exists
func (*CreateRepoData) GetRepository ¶ added in v1.0.82
func (d *CreateRepoData) GetRepository() (*GitRepository, error)
GetRepository returns the repository if it already exists
type GitHubProvider ¶
type GitHubProvider struct { Username string Client *github.Client Context context.Context Server auth.AuthServer User auth.UserAuth }
func (*GitHubProvider) CreatePullRequest ¶
func (p *GitHubProvider) CreatePullRequest(data *GitPullRequestArguments) (*GitPullRequest, error)
func (*GitHubProvider) CreateRepository ¶
func (p *GitHubProvider) CreateRepository(org string, name string, private bool) (*GitRepository, error)
func (*GitHubProvider) CreateWebHook ¶ added in v1.0.6
func (p *GitHubProvider) CreateWebHook(data *GitWebHookArguments) error
func (*GitHubProvider) DeleteRepository ¶ added in v1.0.6
func (p *GitHubProvider) DeleteRepository(org string, name string) error
func (*GitHubProvider) ForkRepository ¶
func (p *GitHubProvider) ForkRepository(originalOrg string, name string, destinationOrg string) (*GitRepository, error)
func (*GitHubProvider) GetRepository ¶ added in v1.0.82
func (p *GitHubProvider) GetRepository(org string, name string) (*GitRepository, error)
func (*GitHubProvider) IsGitHub ¶
func (p *GitHubProvider) IsGitHub() bool
func (*GitHubProvider) JenkinsWebHookPath ¶ added in v1.0.6
func (p *GitHubProvider) JenkinsWebHookPath(gitURL string, secret string) string
func (*GitHubProvider) Label ¶ added in v1.0.16
func (p *GitHubProvider) Label() string
func (*GitHubProvider) ListCommitStatus ¶ added in v1.0.80
func (p *GitHubProvider) ListCommitStatus(org string, repo string, sha string) ([]*GitRepoStatus, error)
func (*GitHubProvider) ListOrganisations ¶
func (p *GitHubProvider) ListOrganisations() ([]GitOrganisation, error)
func (*GitHubProvider) ListRepositories ¶ added in v1.0.6
func (p *GitHubProvider) ListRepositories(org string) ([]*GitRepository, error)
func (*GitHubProvider) MergePullRequest ¶ added in v1.0.80
func (p *GitHubProvider) MergePullRequest(pr *GitPullRequest, message string) error
func (*GitHubProvider) PullRequestLastCommitStatus ¶ added in v1.0.80
func (p *GitHubProvider) PullRequestLastCommitStatus(pr *GitPullRequest) (string, error)
func (*GitHubProvider) RenameRepository ¶
func (p *GitHubProvider) RenameRepository(org string, name string, newName string) (*GitRepository, error)
func (*GitHubProvider) UpdatePullRequestStatus ¶ added in v1.0.63
func (p *GitHubProvider) UpdatePullRequestStatus(pr *GitPullRequest) error
func (*GitHubProvider) ValidateRepositoryName ¶
func (p *GitHubProvider) ValidateRepositoryName(org string, name string) error
type GitOrganisation ¶
type GitOrganisation struct {
Login string
}
type GitProvider ¶
type GitProvider interface { ListOrganisations() ([]GitOrganisation, error) ListRepositories(org string) ([]*GitRepository, error) CreateRepository(org string, name string, private bool) (*GitRepository, error) GetRepository(org string, name string) (*GitRepository, error) DeleteRepository(org string, name string) error ForkRepository(originalOrg string, name string, destinationOrg string) (*GitRepository, error) RenameRepository(org string, name string, newName string) (*GitRepository, error) ValidateRepositoryName(org string, name string) error CreatePullRequest(data *GitPullRequestArguments) (*GitPullRequest, error) UpdatePullRequestStatus(pr *GitPullRequest) error PullRequestLastCommitStatus(pr *GitPullRequest) (string, error) ListCommitStatus(org string, repo string, sha string) ([]*GitRepoStatus, error) MergePullRequest(pr *GitPullRequest, message string) error CreateWebHook(data *GitWebHookArguments) error IsGitHub() bool JenkinsWebHookPath(gitURL string, secret string) string Label() string }
func CreateProvider ¶
func CreateProvider(server *auth.AuthServer, user *auth.UserAuth) (GitProvider, error)
func NewGitHubProvider ¶
func NewGitHubProvider(server *auth.AuthServer, user *auth.UserAuth) (GitProvider, error)
func NewGiteaProvider ¶ added in v1.0.16
func NewGiteaProvider(server *auth.AuthServer, user *auth.UserAuth) (GitProvider, error)
type GitPullRequest ¶
type GitPullRequest struct { URL string Owner string Repo string Number *int Mergeable *bool Merged *bool State *string StatusesURL *string IssueURL *string DiffURL *string MergeCommitSHA *string ClosedAt *time.Time MergedAt *time.Time LastCommitSha string }
func (*GitPullRequest) IsClosed ¶ added in v1.0.63
func (pr *GitPullRequest) IsClosed() bool
IsClosed returns true if the PullRequest has been closed
type GitPullRequestArguments ¶
type GitRepoStatus ¶ added in v1.0.80
type GitRepoStatus struct { ID int64 Context string URL string // State is the current state of the repository. Possible values are: // pending, success, error, or failure. State string `json:"state,omitempty"` // TargetURL is the URL of the page representing this status TargetURL string `json:"target_url,omitempty"` // Description is a short high level summary of the status. Description string }
func (*GitRepoStatus) IsFailed ¶ added in v1.0.80
func (s *GitRepoStatus) IsFailed() bool
func (*GitRepoStatus) IsSuccess ¶ added in v1.0.80
func (s *GitRepoStatus) IsSuccess() bool
type GitRepository ¶
type GitRepository struct { Name string AllowMergeCommit bool HTMLURL string CloneURL string SSHURL string }
func PickRepositories ¶ added in v1.0.6
func PickRepositories(provider GitProvider, owner string, message string, selectAll bool, filter string) ([]*GitRepository, error)
type GitRepositoryInfo ¶
type GitRepositoryInfo struct { URL string Scheme string Host string Organisation string Name string }
func ParseGitURL ¶
func ParseGitURL(text string) (*GitRepositoryInfo, error)
ParseGitURL attempts to parse the given text as a URL or git URL-like string to determine the protocol, host, organisation and name
func (*GitRepositoryInfo) CreateProviderForUser ¶
func (i *GitRepositoryInfo) CreateProviderForUser(server *auth.AuthServer, user *auth.UserAuth) (GitProvider, error)
func (*GitRepositoryInfo) HttpCloneURL ¶ added in v1.0.83
func (i *GitRepositoryInfo) HttpCloneURL() string
HttpCloneURL returns the HTTPS git URL this repository
func (*GitRepositoryInfo) IsGitHub ¶
func (i *GitRepositoryInfo) IsGitHub() bool
func (*GitRepositoryInfo) PickOrCreateProvider ¶
func (i *GitRepositoryInfo) PickOrCreateProvider(authConfigSvc auth.AuthConfigService, message string, batchMode bool) (GitProvider, error)
func (*GitRepositoryInfo) PullRequestURL ¶ added in v1.0.83
func (i *GitRepositoryInfo) PullRequestURL(prName string) string
PullRequestURL returns the URL of a pull request of the given name/number
type GitRepositoryOptions ¶ added in v1.0.37
type GitWebHookArguments ¶ added in v1.0.6
type GiteaProvider ¶ added in v1.0.16
type GiteaProvider struct { Username string Client *gitea.Client Server auth.AuthServer User auth.UserAuth }
func (*GiteaProvider) CreatePullRequest ¶ added in v1.0.16
func (p *GiteaProvider) CreatePullRequest(data *GitPullRequestArguments) (*GitPullRequest, error)
func (*GiteaProvider) CreateRepository ¶ added in v1.0.16
func (p *GiteaProvider) CreateRepository(org string, name string, private bool) (*GitRepository, error)
func (*GiteaProvider) CreateWebHook ¶ added in v1.0.16
func (p *GiteaProvider) CreateWebHook(data *GitWebHookArguments) error
func (*GiteaProvider) DeleteRepository ¶ added in v1.0.16
func (p *GiteaProvider) DeleteRepository(org string, name string) error
func (*GiteaProvider) ForkRepository ¶ added in v1.0.16
func (p *GiteaProvider) ForkRepository(originalOrg string, name string, destinationOrg string) (*GitRepository, error)
func (*GiteaProvider) GetRepository ¶ added in v1.0.82
func (p *GiteaProvider) GetRepository(org string, name string) (*GitRepository, error)
func (*GiteaProvider) IsGitHub ¶ added in v1.0.16
func (p *GiteaProvider) IsGitHub() bool
func (*GiteaProvider) JenkinsWebHookPath ¶ added in v1.0.16
func (p *GiteaProvider) JenkinsWebHookPath(gitURL string, secret string) string
func (*GiteaProvider) Label ¶ added in v1.0.16
func (p *GiteaProvider) Label() string
func (*GiteaProvider) ListCommitStatus ¶ added in v1.0.80
func (p *GiteaProvider) ListCommitStatus(org string, repo string, sha string) ([]*GitRepoStatus, error)
func (*GiteaProvider) ListOrganisations ¶ added in v1.0.16
func (p *GiteaProvider) ListOrganisations() ([]GitOrganisation, error)
func (*GiteaProvider) ListRepositories ¶ added in v1.0.16
func (p *GiteaProvider) ListRepositories(org string) ([]*GitRepository, error)
func (*GiteaProvider) MergePullRequest ¶ added in v1.0.80
func (p *GiteaProvider) MergePullRequest(pr *GitPullRequest, message string) error
func (*GiteaProvider) PullRequestLastCommitStatus ¶ added in v1.0.80
func (p *GiteaProvider) PullRequestLastCommitStatus(pr *GitPullRequest) (string, error)
func (*GiteaProvider) RenameRepository ¶ added in v1.0.16
func (p *GiteaProvider) RenameRepository(org string, name string, newName string) (*GitRepository, error)
func (*GiteaProvider) UpdatePullRequestStatus ¶ added in v1.0.63
func (p *GiteaProvider) UpdatePullRequestStatus(pr *GitPullRequest) error
func (*GiteaProvider) ValidateRepositoryName ¶ added in v1.0.16
func (p *GiteaProvider) ValidateRepositoryName(org string, name string) error