github

Documentation

Index

• type ActionsService
• type Client
  • func NewClient(ctx context.Context) *Client
  • func (c *Client) ListWorkflowJobs(ctx context.Context, logE *logrus.Entry, owner, repo string, runID int64, ...) ([]*WorkflowJob, *github.Response, error)
  • func (c *Client) ListWorkflowRuns(ctx context.Context, owner, repo, workflowFileName string, ...) ([]*WorkflowRun, *github.Response, error)
• type ListWorkflowJobsOptions
• type ListWorkflowRunsOptions
• type Response
• type WorkflowJob
• type WorkflowRun

Types

type ActionsService

type ActionsService interface {
	ListWorkflowRunsByFileName(ctx context.Context, owner, repo, workflowFileName string, opts *github.ListWorkflowRunsOptions) (*github.WorkflowRuns, *github.Response, error)
	ListWorkflowJobs(ctx context.Context, owner, repo string, runID int64, opts *github.ListWorkflowJobsOptions) (*github.Jobs, *github.Response, error)
}

type Client

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

func NewClient

func NewClient(ctx context.Context) *Client

func (*Client) ListWorkflowJobs

func (c *Client) ListWorkflowJobs(ctx context.Context, logE *logrus.Entry, owner, repo string, runID int64, opts *ListWorkflowJobsOptions) ([]*WorkflowJob, *github.Response, error)

func (*Client) ListWorkflowRuns

func (c *Client) ListWorkflowRuns(ctx context.Context, owner, repo, workflowFileName string, opts *ListWorkflowRunsOptions) ([]*WorkflowRun, *github.Response, error)

type ListWorkflowJobsOptions

type ListWorkflowJobsOptions struct {
	Date   int
	Status string
	Page   int
}

type ListWorkflowRunsOptions

type ListWorkflowRunsOptions struct {
	Status string
	Page   int
}

type Response

type Response = github.Response

type WorkflowJob

type WorkflowJob struct {
	ID   int64
	Name string
	// The phase of the lifecycle that the job is currently in.
	// "queued", "in_progress", "completed", "waiting", "requested", "pending"
	Status string
	// The outcome of the job.
	// "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required",
	Conclusion string
	Duration   time.Duration
}

type WorkflowRun

type WorkflowRun struct {
	ID int64
	// Can be one of: completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending
	Status string
}