Documentation
¶
Index ¶
- func Annotate(action *githubactions.Action, level AnnotationLevel, title string, ...)
- func Checkout(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (tempDir string, err error)
- func GetPR(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (pullRequest *github.PullRequest, err error)
- func GetPRChangedFiles(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (changedFiles []string, err error)
- func GetPRChangedFilesWithStatus(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (changedFiles map[string]FileStatus, err error)
- func ReadPullRequest(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (*github.PullRequest, error)
- func WriteComment(cxt context.Context, githubContext *githubactions.GitHubContext, ...) (err error)
- func WriteSummary(cxt context.Context, action *githubactions.Action, result string) (err error)
- type AnnotationLevel
- type FileStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Annotate ¶ added in v1.7.13
func Annotate(action *githubactions.Action, level AnnotationLevel, title string, message string, file string, line int)
func Checkout ¶
func Checkout(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action, pr *github.PullRequest, ref string, outDir string) (tempDir string, err error)
func GetPR ¶
func GetPR(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action, pr *github.PullRequest) (pullRequest *github.PullRequest, err error)
func GetPRChangedFiles ¶
func GetPRChangedFiles(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action, pr *github.PullRequest) (changedFiles []string, err error)
func GetPRChangedFilesWithStatus ¶ added in v1.6.15
func GetPRChangedFilesWithStatus(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action, pr *github.PullRequest) (changedFiles map[string]FileStatus, err error)
func ReadPullRequest ¶
func ReadPullRequest(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action) (*github.PullRequest, error)
func WriteComment ¶
func WriteComment(cxt context.Context, githubContext *githubactions.GitHubContext, action *githubactions.Action, pr *github.PullRequest, messageId string, comment string) (err error)
func WriteSummary ¶ added in v1.7.13
Types ¶
type AnnotationLevel ¶ added in v1.7.13
type AnnotationLevel int
const ( AnnotationLevelError AnnotationLevel = 0 AnnotationLevelWarning AnnotationLevel = 1 AnnotationLevelNotice AnnotationLevel = 2 )
func (AnnotationLevel) String ¶ added in v1.7.13
func (al AnnotationLevel) String() string
type FileStatus ¶ added in v1.6.15
type FileStatus string
const ( FileStatusAdded FileStatus = "added" FileStatusModified FileStatus = "modified" FileStatusDeleted FileStatus = "deleted" )
Click to show internal directories.
Click to hide internal directories.