plugin

Documentation

Index

• Variables
• func GitHubPlugin(plugin Executor) func(w http.ResponseWriter, req *http.Request)
• type ActionSpec
• type Executor
• type GitHubClient
• type GitHubExecutor
  • func NewGitHubExecutor(client *GitHubClient, agentToken string) GitHubExecutor
  • func (e *GitHubExecutor) Authorize(req *http.Request) error
  • func (e *GitHubExecutor) Execute(args executor.ExecuteTemplateArgs) executor.ExecuteTemplateReply
• type GitHubIssuesClient
• type IssueActionSpec
• type IssueCommentAction
• type IssueCreateAction
• type PluginSpec

Variables

var (
	ErrWrongContentType = errors.New("Content-Type header is not set to 'application/json'")
	ErrReadingBody      = errors.New("couldn't read request body")
	ErrMarshallingBody  = errors.New("couldn't unmarshal request body")
)

Functions

func GitHubPlugin

func GitHubPlugin(plugin Executor) func(w http.ResponseWriter, req *http.Request)

Types

type ActionSpec

type ActionSpec struct {
	Issue   *IssueActionSpec `json:"issue,omitempty"`
	Timeout string           `json:"timeout,omitempty"`
}

type Executor

type Executor interface {
	Authorize(req *http.Request) error
	// Execute runs commands based on the args provided from the workflow
	Execute(args executor.ExecuteTemplateArgs) executor.ExecuteTemplateReply
}

Executor performs the tasks requested by the Workflow.

type GitHubClient

type GitHubClient struct {
	Issues GitHubIssuesClient
}

type GitHubExecutor

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

func NewGitHubExecutor

func NewGitHubExecutor(client *GitHubClient, agentToken string) GitHubExecutor

func (*GitHubExecutor) Authorize

func (e *GitHubExecutor) Authorize(req *http.Request) error

func (*GitHubExecutor) Execute

func (e *GitHubExecutor) Execute(args executor.ExecuteTemplateArgs) executor.ExecuteTemplateReply

type GitHubIssuesClient

type GitHubIssuesClient interface {
	CreateComment(ctx context.Context, owner, repo string, number int, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)
	Create(ctx context.Context, owner, repo string, issue *github.IssueRequest) (*github.Issue, *github.Response, error)
}

type IssueActionSpec

type IssueActionSpec struct {
	Comment *IssueCommentAction `json:"comment,omitempty"`
	Create  *IssueCreateAction  `json:"create,omitempty"`
}

type IssueCommentAction

type IssueCommentAction struct {
	Body   string `json:"body,omitempty"`
	Owner  string `json:"owner,omitempty"`
	Repo   string `json:"repo,omitempty"`
	Number string `json:"number,omitempty"`
}

type IssueCreateAction

type IssueCreateAction struct {
	Owner   string               `json:"owner,omitempty"`
	Repo    string               `json:"repo,omitempty"`
	Request *github.IssueRequest `json:"-"`
}

type PluginSpec

type PluginSpec struct {
	GitHub *ActionSpec `json:"github,omitempty"`
}

PluginSpec represents the `plugin` block of an Argo Workflows template.