github

Documentation

Overview

Package github defines a router for targeting GitHub subjects.

Index

• type DotCom
  • func (DotCom) IssueCommentURL(_ context.Context, owner, repo string, issueID, commentID uint64) string
  • func (DotCom) IssueEventURL(_ context.Context, owner, repo string, issueID, eventID uint64) string
  • func (DotCom) IssueURL(_ context.Context, owner, repo string, issueID uint64) string
  • func (DotCom) PullRequestCommentURL(_ context.Context, owner, repo string, prID, commentID uint64) string
  • func (DotCom) PullRequestEventURL(_ context.Context, owner, repo string, prID, eventID uint64) string
  • func (DotCom) PullRequestReviewCommentURL(_ context.Context, owner, repo string, prID, reviewCommentID uint64) string
  • func (DotCom) PullRequestReviewURL(_ context.Context, owner, repo string, prID, reviewID uint64) string
  • func (DotCom) PullRequestURL(_ context.Context, owner, repo string, prID uint64) string
• type Router

Types

type DotCom

type DotCom struct{}

DotCom provides HTML URLs of GitHub subjects on github.com.

func (DotCom) IssueCommentURL

func (DotCom) IssueCommentURL(_ context.Context, owner, repo string, issueID, commentID uint64) string

IssueCommentURL returns the HTML URL of the specified GitHub issue comment on github.com.

func (DotCom) IssueEventURL

func (DotCom) IssueEventURL(_ context.Context, owner, repo string, issueID, eventID uint64) string

IssueEventURL returns the HTML URL of the specified GitHub issue event on github.com.

func (DotCom) IssueURL

func (DotCom) IssueURL(_ context.Context, owner, repo string, issueID uint64) string

IssueURL returns the HTML URL of the specified GitHub issue on github.com.

func (DotCom) PullRequestCommentURL

func (DotCom) PullRequestCommentURL(_ context.Context, owner, repo string, prID, commentID uint64) string

PullRequestCommentURL returns the HTML URL of the specified GitHub pull request comment on github.com.

func (DotCom) PullRequestEventURL

func (DotCom) PullRequestEventURL(_ context.Context, owner, repo string, prID, eventID uint64) string

PullRequestEventURL returns the HTML URL of the specified GitHub pull request event on github.com.

func (DotCom) PullRequestReviewCommentURL

func (DotCom) PullRequestReviewCommentURL(_ context.Context, owner, repo string, prID, reviewCommentID uint64) string

PullRequestReviewCommentURL returns the HTML URL of the specified GitHub pull request review comment on github.com.

func (DotCom) PullRequestReviewURL

func (DotCom) PullRequestReviewURL(_ context.Context, owner, repo string, prID, reviewID uint64) string

PullRequestReviewURL returns the HTML URL of the specified GitHub pull request review on github.com.

func (DotCom) PullRequestURL

func (DotCom) PullRequestURL(_ context.Context, owner, repo string, prID uint64) string

PullRequestURL returns the HTML URL of the specified GitHub pull request on github.com.

type Router

type Router interface {
	// IssueURL returns the HTML URL of the specified GitHub issue.
	IssueURL(ctx context.Context, owner, repo string, issueID uint64) string

	// IssueCommentURL returns the HTML URL of the specified GitHub issue comment.
	IssueCommentURL(ctx context.Context, owner, repo string, issueID, commentID uint64) string

	// IssueEventURL returns the HTML URL of the specified GitHub issue event.
	IssueEventURL(ctx context.Context, owner, repo string, issueID, eventID uint64) string

	// PullRequestURL returns the HTML URL of the specified GitHub pull request.
	PullRequestURL(ctx context.Context, owner, repo string, prID uint64) string

	// PullRequestCommentURL returns the HTML URL of the specified GitHub pull request comment.
	PullRequestCommentURL(ctx context.Context, owner, repo string, prID, commentID uint64) string

	// PullRequestReviewURL returns the HTML URL of the specified GitHub pull request review.
	PullRequestReviewURL(ctx context.Context, owner, repo string, prID, reviewID uint64) string

	// PullRequestReviewCommentURL returns the HTML URL of the specified GitHub pull request review comment.
	PullRequestReviewCommentURL(ctx context.Context, owner, repo string, prID, reviewCommentID uint64) string

	// PullRequestEventURL returns the HTML URL of the specified GitHub pull request event.
	PullRequestEventURL(ctx context.Context, owner, repo string, prID, eventID uint64) string
}

Router provides HTML URLs of GitHub subjects.