Help us shape the future of Go! Take the 2026 Go Developer Survey

github

package
v1.7.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

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

func WriteSummary(cxt context.Context, action *githubactions.Action, result string) (err error)

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"
)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL