sdk

Documentation

Index

• Constants
• func AttributeFromContext(ctx context.Context, key string) interface{}
• func Serve(b Bot)
• type Bot
  • func NewBot(name string, opts ...BotOptions) Bot
  • func (b *Bot) RegisterHandler(handler EventHandlerFunc)
• type BotOptions
  • func BotWithHandler(handler EventHandlerFunc) BotOptions
• type EventHandlerFunc
• type EventType
• type GitHubClient
  • func NewGitHubClient(ctx context.Context, org, repo, policyName string) GitHubClient
  • func (c GitHubClient) AddLabel(ctx context.Context, pr *github.PullRequest, label string) error
  • func (c GitHubClient) Client() *github.Client
  • func (c GitHubClient) Close(ctx context.Context) error
  • func (c GitHubClient) GetWorkflowRunLogs(ctx context.Context, wre github.WorkflowRunEvent) ([]byte, error)
  • func (c GitHubClient) GetWorkloadRunPullRequestNumber(ctx context.Context, wre github.WorkflowRunEvent) (int, error)
  • func (c GitHubClient) RemoveLabel(ctx context.Context, pr *github.PullRequest, label string) error
  • func (c GitHubClient) SetComment(ctx context.Context, pr *github.PullRequest, botName, content string) error
• type IssueCommentHandler
  • func (r IssueCommentHandler) EventType() EventType
• type PullRequestHandler
  • func (r PullRequestHandler) EventType() EventType
• type WorkflowRunHandler
  • func (r WorkflowRunHandler) EventType() EventType

Constants

const (
	ContextKeyAttributes contextKey = "ce-attributes"
	ContextKeyType       contextKey = "ce-type"
)

Define constants for the keys to use with context.WithValue.

Functions

func AttributeFromContext

func AttributeFromContext(ctx context.Context, key string) interface{}

AttributeFromContext retrieves an attribute by key from the context. Returns nil if the attribute does not exist.

func Serve

func Serve(b Bot)

Types

type Bot

type Bot struct {
	Name     string
	Handlers map[EventType]EventHandlerFunc
}

func NewBot

func NewBot(name string, opts ...BotOptions) Bot

func (*Bot) RegisterHandler

func (b *Bot) RegisterHandler(handler EventHandlerFunc)

type BotOptions

type BotOptions func(*Bot)

func BotWithHandler

func BotWithHandler(handler EventHandlerFunc) BotOptions

type EventHandlerFunc

type EventHandlerFunc interface {
	EventType() EventType
}

type EventType

type EventType string

const (
	PullRequestEvent  EventType = "dev.chainguard.github.pull_request"
	WorkflowRunEvent  EventType = "dev.chainguard.github.workflow_run"
	IssueCommentEvent EventType = "dev.chainguard.github.issue_comment"
)

type GitHubClient

type GitHubClient struct {
	// contains filtered or unexported fields
}

func NewGitHubClient

func NewGitHubClient(ctx context.Context, org, repo, policyName string) GitHubClient

NewGitHubClient creates a new GitHub client, using a new token from OctoSTS, for the given org, repo and policy name.

A new token is created for each client, and is not refreshed. It can be revoked with Close.

func (GitHubClient) AddLabel

func (c GitHubClient) AddLabel(ctx context.Context, pr *github.PullRequest, label string) error

func (GitHubClient) Client

func (c GitHubClient) Client() *github.Client

func (GitHubClient) Close

func (c GitHubClient) Close(ctx context.Context) error

func (GitHubClient) GetWorkflowRunLogs

func (c GitHubClient) GetWorkflowRunLogs(ctx context.Context, wre github.WorkflowRunEvent) ([]byte, error)

func (GitHubClient) GetWorkloadRunPullRequestNumber

func (c GitHubClient) GetWorkloadRunPullRequestNumber(ctx context.Context, wre github.WorkflowRunEvent) (int, error)

func (GitHubClient) RemoveLabel

func (c GitHubClient) RemoveLabel(ctx context.Context, pr *github.PullRequest, label string) error

func (GitHubClient) SetComment

func (c GitHubClient) SetComment(ctx context.Context, pr *github.PullRequest, botName, content string) error

type IssueCommentHandler

type IssueCommentHandler func(ctx context.Context, ice github.IssueCommentEvent, ic *github.IssueComment) error

func (IssueCommentHandler) EventType

func (r IssueCommentHandler) EventType() EventType

type PullRequestHandler

type PullRequestHandler func(ctx context.Context, pre github.PullRequestEvent, pr *github.PullRequest) error

func (PullRequestHandler) EventType

func (r PullRequestHandler) EventType() EventType

type WorkflowRunHandler

type WorkflowRunHandler func(ctx context.Context, wre github.WorkflowRunEvent, wr *github.WorkflowRun) error

func (WorkflowRunHandler) EventType

func (r WorkflowRunHandler) EventType() EventType