Documentation
¶
Overview ¶
Package github implements GitHub's pull-request API as a git publishing provider.
Index ¶
Constants ¶
const ProviderName = "github"
ProviderName identifies the GitHub pull request publisher.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider reconciles pull requests through GitHub's REST API.
func New ¶
func New() *Provider
New creates a GitHub pull request provider using the configured CI token.
func NewWithClientFactory ¶
NewWithClientFactory exists for fake HTTP client tests without exposing the go-github dependency to caller packages.
func (*Provider) PullRequestBodyBadge ¶ added in v1.229.0
PullRequestBodyBadge implements atmosgit.PullRequestBodyBadger.
func (*Provider) Reconcile ¶
func (p *Provider) Reconcile(ctx context.Context, options *atmosgit.PullRequestOptions) (*atmosgit.PullRequestResult, error)
Reconcile creates or updates a pull request and applies configured metadata.
func (*Provider) RepositoryFromURL ¶
func (p *Provider) RepositoryFromURL(uri string) (atmosgit.PullRequestRepository, bool)
RepositoryFromURL recognizes remotes on the GitHub host this provider's API client talks to over HTTPS or SSH and returns their owner/repository: github.com by default, or the Enterprise Server host named by GITHUB_SERVER_URL. Only that one host is claimed, so a resolved repository is always one the client can reach. Ports are ignored, matching atmosgit.GitHubRepository, since scp-style SSH remotes carry none.
Source Files