handler

package

v0.0.3 Latest Latest Go to latest Published: Aug 11, 2022 License: LGPL-3.0 Imports: 8 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/reviewpad/host-event-handler

Links

Open Source Insights

Documentation ¶

Index ¶

func Log(format string, a ...interface{})
type ActionEvent
- func ParseEvent(rawEvent string) (*ActionEvent, error)
type TargetEntity
- func ProcessEvent(event *ActionEvent) ([]*TargetEntity, error)
type TargetEntityKind

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Log ¶

func Log(format string, a ...interface{})

Types ¶

type ActionEvent ¶

type ActionEvent struct {
	ActionName       *string          `json:"action,omitempty"`
	ActionPath       *string          `json:"action_path,omitempty"`
	ActionRef        *string          `json:"action_ref,omitempty"`
	ActionRepository *string          `json:"action_repository,omitempty"`
	ActionStatus     *string          `json:"action_status,omitempty"`
	Actor            *string          `json:"actor,omitempty"`
	ApiUrl           *string          `json:"api_url,omitempty"`
	BaseRef          *string          `json:"base_ref,omitempty"`
	HeadRef          *string          `json:"head_ref,omitempty"`
	Env              *string          `json:"env,omitempty"`
	EventPayload     *json.RawMessage `json:"event,omitempty"`
	EventName        *string          `json:"event_name,omitempty"`
	EventPath        *string          `json:"event_path,omitempty"`
	QraphqlUrl       *string          `json:"graphql_url,omitempty"`
	JobID            *string          `json:"job,omitempty"`
	Ref              *string          `json:"ref,omitempty"`
	RefName          *string          `json:"ref_name,omitempty"`
	RefProtected     *bool            `json:"ref_protected,omitempty"`
	RefType          *string          `json:"ref_type,omitempty"`
	Path             *string          `json:"path,omitempty"`
	Repository       *string          `json:"repository,omitempty"`
	RepositoryOwner  *string          `json:"repository_owner,omitempty"`
	RepositoryUrl    *string          `json:"repositoryUrl,omitempty"`
	RetentionDays    *string          `json:"retention_days,omitempty"`
	RunID            *string          `json:"run_id,omitempty"`
	RunNumber        *string          `json:"run_number,omitempty"`
	RunAttempt       *string          `json:"run_attempt,omitempty"`
	ServerUrl        *string          `json:"server_url,omitempty"`
	SHA              *string          `json:"sha,omitempty"`
	Token            *string          `json:"token,omitempty"`
	Workflow         *string          `json:"workflow,omitempty"`
	Workspace        *string          `json:"workspace,omitempty"`
}

ActionEvent contains information about the workflow run and the event that triggered the run. For more information, visit: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context

func ParseEvent ¶

func ParseEvent(rawEvent string) (*ActionEvent, error)

type TargetEntity ¶ added in v0.0.3

type TargetEntity struct {
	Kind   TargetEntityKind
	Number int
}

func ProcessEvent ¶

func ProcessEvent(event *ActionEvent) ([]*TargetEntity, error)

reviewpad-an: critical output: the list of pull requests/issues that are affected by the event.

type TargetEntityKind ¶ added in v0.0.3

type TargetEntityKind string

const (
	PullRequest TargetEntityKind = "pull_request"
	Issue       TargetEntityKind = "issue"
)

Source Files ¶

View all Source files

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