Documentation
¶
Overview ¶
Package github publishes pipeline report comments to GitHub pull requests.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider posts report comments via the GitHub Issues comments API (pull request conversation comments are issue comments).
func New ¶
New creates a GitHub provider. For hosts other than github.com the GitHub Enterprise API prefix (/api/v3) is used.
func NewWithClient ¶
NewWithClient creates a provider with a pre-configured client (used in tests).
func (*Provider) SetCommitStatus ¶
func (p *Provider) SetCommitStatus(ctx context.Context, ref types.CommitRef, status types.CommitStatus) error
SetCommitStatus posts a commit status via the GitHub commit statuses API.
func (*Provider) SupportsCollapsibleSections ¶
SupportsCollapsibleSections reports that GitHub renders embedded HTML (<details>/<summary>) inside markdown comments.
func (*Provider) UpsertComment ¶
func (p *Provider) UpsertComment(ctx context.Context, ref types.PullRequestRef, comment types.Comment) error
UpsertComment creates the report comment or, when comment.Update is set, edits the previous report comment identified by the marker.
Source Files