github

package
v0.0.39 Latest Latest
Warning

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

 Go to latest Published: Jan 7, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	GitHubAppPEM           = "pem"
	GitHubAppClientSecret  = "clientSecret"
	GitHubAppWebhookSecret = "webhookSecret"
)
View Source 
const (
	WorkflowPayloadType          = "github.workflow.finished"
	WorkflowPassedOutputChannel  = "passed"
	WorkflowFailedOutputChannel  = "failed"
	WorkflowRunStatusCompleted   = "completed"
	WorkflowRunConclusionSuccess = "success"
	WorkflowPollInterval         = 5 * time.Minute
)

Variables

This section is empty.

Functions

func NewClient 

func NewClient(ctx core.AppInstallationContext, ghAppID int64, installationID string) (*github.Client, error)

Types

type Configuration 

type Configuration struct {
	Organization string `json:"organization"`
}

type CreateIssue added in v0.0.18 

type CreateIssue struct{}

func (*CreateIssue) Actions added in v0.0.18 

func (c *CreateIssue) Actions() []core.Action

func (*CreateIssue) Cancel added in v0.0.18 

func (c *CreateIssue) Cancel(ctx core.ExecutionContext) error

func (*CreateIssue) Color added in v0.0.18 

func (c *CreateIssue) Color() string

func (*CreateIssue) Configuration added in v0.0.18 

func (c *CreateIssue) Configuration() []configuration.Field

func (*CreateIssue) Description added in v0.0.18 

func (c *CreateIssue) Description() string

func (*CreateIssue) Execute added in v0.0.18 

func (c *CreateIssue) Execute(ctx core.ExecutionContext) error

func (*CreateIssue) HandleAction added in v0.0.18 

func (c *CreateIssue) HandleAction(ctx core.ActionContext) error

func (*CreateIssue) HandleWebhook added in v0.0.18 

func (c *CreateIssue) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*CreateIssue) Icon added in v0.0.18 

func (c *CreateIssue) Icon() string

func (*CreateIssue) Label added in v0.0.18 

func (c *CreateIssue) Label() string

func (*CreateIssue) Name added in v0.0.18 

func (c *CreateIssue) Name() string

func (*CreateIssue) OutputChannels added in v0.0.18 

func (c *CreateIssue) OutputChannels(configuration any) []core.OutputChannel

func (*CreateIssue) ProcessQueueItem added in v0.0.18 

func (c *CreateIssue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateIssue) Setup added in v0.0.18 

func (c *CreateIssue) Setup(ctx core.SetupContext) error

type CreateIssueConfiguration added in v0.0.18 

type CreateIssueConfiguration struct {
	Repository string   `mapstructure:"repository"`
	Title      string   `mapstructure:"title"`
	Body       string   `mapstructure:"body"`
	Assignees  []string `mapstructure:"assignees"`
	Labels     []string `mapstructure:"labels"`
}

type GetIssue added in v0.0.18 

type GetIssue struct{}

func (*GetIssue) Actions added in v0.0.18 

func (c *GetIssue) Actions() []core.Action

func (*GetIssue) Cancel added in v0.0.18 

func (c *GetIssue) Cancel(ctx core.ExecutionContext) error

func (*GetIssue) Color added in v0.0.18 

func (c *GetIssue) Color() string

func (*GetIssue) Configuration added in v0.0.18 

func (c *GetIssue) Configuration() []configuration.Field

func (*GetIssue) Description added in v0.0.18 

func (c *GetIssue) Description() string

func (*GetIssue) Execute added in v0.0.18 

func (c *GetIssue) Execute(ctx core.ExecutionContext) error

func (*GetIssue) HandleAction added in v0.0.18 

func (c *GetIssue) HandleAction(ctx core.ActionContext) error

func (*GetIssue) HandleWebhook added in v0.0.18 

func (c *GetIssue) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*GetIssue) Icon added in v0.0.18 

func (c *GetIssue) Icon() string

func (*GetIssue) Label added in v0.0.18 

func (c *GetIssue) Label() string

func (*GetIssue) Name added in v0.0.18 

func (c *GetIssue) Name() string

func (*GetIssue) OutputChannels added in v0.0.18 

func (c *GetIssue) OutputChannels(configuration any) []core.OutputChannel

func (*GetIssue) ProcessQueueItem added in v0.0.18 

func (c *GetIssue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetIssue) Setup added in v0.0.18 

func (c *GetIssue) Setup(ctx core.SetupContext) error

type GetIssueConfiguration added in v0.0.18 

type GetIssueConfiguration struct {
	Repository  string `json:"repository" mapstructure:"repository"`
	IssueNumber string `json:"issueNumber" mapstructure:"issueNumber"`
}

type GitHub 

type GitHub struct {
}

func (*GitHub) CleanupWebhook 

func (g *GitHub) CleanupWebhook(ctx core.CleanupWebhookContext) error

func (*GitHub) CompareWebhookConfig 

func (g *GitHub) CompareWebhookConfig(a, b any) (bool, error)

func (*GitHub) Components 

func (g *GitHub) Components() []core.Component

func (*GitHub) Configuration 

func (g *GitHub) Configuration() []configuration.Field

func (*GitHub) Description 

func (g *GitHub) Description() string

func (*GitHub) HandleRequest 

func (g *GitHub) HandleRequest(ctx core.HTTPRequestContext)

func (*GitHub) Icon 

func (g *GitHub) Icon() string

func (*GitHub) Label 

func (g *GitHub) Label() string

func (*GitHub) Name 

func (g *GitHub) Name() string

func (*GitHub) SetupWebhook 

func (g *GitHub) SetupWebhook(ctx core.SetupWebhookContext) (any, error)

func (*GitHub) Sync 

func (g *GitHub) Sync(ctx core.SyncContext) error

func (*GitHub) Triggers 

func (g *GitHub) Triggers() []core.Trigger

type GitHubAppData 

type GitHubAppData struct {
	ID            int64  `mapstructure:"id" json:"id"`
	Slug          string `mapstructure:"slug" json:"slug"`
	ClientID      string `mapstructure:"client_id" json:"client_id"`
	ClientSecret  string `mapstructure:"client_secret" json:"client_secret"`
	WebhookSecret string `mapstructure:"webhook_secret" json:"webhook_secret"`
	PEM           string `mapstructure:"pem" json:"pem"`
}

* This is the response GitHub sends back after the GitHub app is created. * NOTE: this contains sensitive data, so we should not save this as part * of the installation metadata.

type GitHubAppMetadata 

type GitHubAppMetadata struct {
	ID       int64  `mapstructure:"id" json:"id"`
	Slug     string `mapstructure:"slug" json:"slug"`
	ClientID string `mapstructure:"clientId" json:"clientId"`
}

type Input added in v0.0.18 

type Input struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type Metadata 

type Metadata struct {
	InstallationID string            `mapstructure:"installationId" json:"installationId"`
	State          string            `mapstructure:"state" json:"state"`
	Owner          string            `mapstructure:"owner" json:"owner"`
	Repositories   []Repository      `mapstructure:"repositories" json:"repositories"`
	GitHubApp      GitHubAppMetadata `mapstructure:"githubApp" json:"githubApp"`
}

type NodeMetadata added in v0.0.18 

type NodeMetadata struct {
	Repository *Repository `json:"repository"`
}

type OnBranchCreated added in v0.0.18 

type OnBranchCreated struct{}

func (*OnBranchCreated) Actions added in v0.0.18 

func (t *OnBranchCreated) Actions() []core.Action

func (*OnBranchCreated) Color added in v0.0.18 

func (t *OnBranchCreated) Color() string

func (*OnBranchCreated) Configuration added in v0.0.18 

func (t *OnBranchCreated) Configuration() []configuration.Field

func (*OnBranchCreated) Description added in v0.0.18 

func (t *OnBranchCreated) Description() string

func (*OnBranchCreated) HandleAction added in v0.0.18 

func (t *OnBranchCreated) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnBranchCreated) HandleWebhook added in v0.0.18 

func (t *OnBranchCreated) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnBranchCreated) Icon added in v0.0.18 

func (t *OnBranchCreated) Icon() string

func (*OnBranchCreated) Label added in v0.0.18 

func (t *OnBranchCreated) Label() string

func (*OnBranchCreated) Name added in v0.0.18 

func (t *OnBranchCreated) Name() string

func (*OnBranchCreated) Setup added in v0.0.18 

func (t *OnBranchCreated) Setup(ctx core.TriggerContext) error

type OnBranchCreatedConfiguration added in v0.0.18 

type OnBranchCreatedConfiguration struct {
	Repository string                    `json:"repository"`
	Branches   []configuration.Predicate `json:"branches"`
}

type OnIssue 

type OnIssue struct{}

func (*OnIssue) Actions 

func (i *OnIssue) Actions() []core.Action

func (*OnIssue) Color 

func (i *OnIssue) Color() string

func (*OnIssue) Configuration 

func (i *OnIssue) Configuration() []configuration.Field

func (*OnIssue) Description 

func (i *OnIssue) Description() string

func (*OnIssue) HandleAction 

func (i *OnIssue) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnIssue) HandleWebhook 

func (i *OnIssue) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnIssue) Icon 

func (i *OnIssue) Icon() string

func (*OnIssue) Label 

func (i *OnIssue) Label() string

func (*OnIssue) Name 

func (i *OnIssue) Name() string

func (*OnIssue) Setup 

func (i *OnIssue) Setup(ctx core.TriggerContext) error

type OnIssueConfiguration 

type OnIssueConfiguration struct {
	Repository string   `json:"repository" mapstructure:"repository"`
	Actions    []string `json:"actions" mapstructure:"actions"`
}

type OnPullRequest 

type OnPullRequest struct{}

func (*OnPullRequest) Actions 

func (p *OnPullRequest) Actions() []core.Action

func (*OnPullRequest) Color 

func (p *OnPullRequest) Color() string

func (*OnPullRequest) Configuration 

func (p *OnPullRequest) Configuration() []configuration.Field

func (*OnPullRequest) Description 

func (p *OnPullRequest) Description() string

func (*OnPullRequest) HandleAction 

func (p *OnPullRequest) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnPullRequest) HandleWebhook 

func (p *OnPullRequest) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnPullRequest) Icon 

func (p *OnPullRequest) Icon() string

func (*OnPullRequest) Label 

func (p *OnPullRequest) Label() string

func (*OnPullRequest) Name 

func (p *OnPullRequest) Name() string

func (*OnPullRequest) Setup 

func (p *OnPullRequest) Setup(ctx core.TriggerContext) error

type OnPullRequestConfiguration 

type OnPullRequestConfiguration struct {
	Repository string   `json:"repository" mapstructure:"repository"`
	Actions    []string `json:"actions" mapstructure:"actions"`
}

type OnPush 

type OnPush struct{}

func (*OnPush) Actions 

func (p *OnPush) Actions() []core.Action

func (*OnPush) Color 

func (p *OnPush) Color() string

func (*OnPush) Configuration 

func (p *OnPush) Configuration() []configuration.Field

func (*OnPush) Description 

func (p *OnPush) Description() string

func (*OnPush) HandleAction 

func (p *OnPush) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnPush) HandleWebhook 

func (p *OnPush) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnPush) Icon 

func (p *OnPush) Icon() string

func (*OnPush) Label 

func (p *OnPush) Label() string

func (*OnPush) Name 

func (p *OnPush) Name() string

func (*OnPush) Setup 

func (p *OnPush) Setup(ctx core.TriggerContext) error

type OnPushConfiguration 

type OnPushConfiguration struct {
	Repository string                    `json:"repository" mapstructure:"repository"`
	Refs       []configuration.Predicate `json:"refs" mapstructure:"refs"`
}

type OnRelease 

type OnRelease struct{}

func (*OnRelease) Actions 

func (r *OnRelease) Actions() []core.Action

func (*OnRelease) Color 

func (r *OnRelease) Color() string

func (*OnRelease) Configuration 

func (r *OnRelease) Configuration() []configuration.Field

func (*OnRelease) Description 

func (r *OnRelease) Description() string

func (*OnRelease) HandleAction 

func (r *OnRelease) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnRelease) HandleWebhook 

func (r *OnRelease) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnRelease) Icon 

func (r *OnRelease) Icon() string

func (*OnRelease) Label 

func (r *OnRelease) Label() string

func (*OnRelease) Name 

func (r *OnRelease) Name() string

func (*OnRelease) Setup 

func (r *OnRelease) Setup(ctx core.TriggerContext) error

type OnReleaseConfiguration 

type OnReleaseConfiguration struct {
	Repository string   `json:"repository" mapstructure:"repository"`
	Actions    []string `json:"actions" mapstructure:"actions"`
}

type OnTagCreated added in v0.0.18 

type OnTagCreated struct{}

func (*OnTagCreated) Actions added in v0.0.18 

func (t *OnTagCreated) Actions() []core.Action

func (*OnTagCreated) Color added in v0.0.18 

func (t *OnTagCreated) Color() string

func (*OnTagCreated) Configuration added in v0.0.18 

func (t *OnTagCreated) Configuration() []configuration.Field

func (*OnTagCreated) Description added in v0.0.18 

func (t *OnTagCreated) Description() string

func (*OnTagCreated) HandleAction added in v0.0.18 

func (t *OnTagCreated) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnTagCreated) HandleWebhook added in v0.0.18 

func (t *OnTagCreated) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnTagCreated) Icon added in v0.0.18 

func (t *OnTagCreated) Icon() string

func (*OnTagCreated) Label added in v0.0.18 

func (t *OnTagCreated) Label() string

func (*OnTagCreated) Name added in v0.0.18 

func (t *OnTagCreated) Name() string

func (*OnTagCreated) Setup added in v0.0.18 

func (t *OnTagCreated) Setup(ctx core.TriggerContext) error

type OnTagCreatedConfiguration added in v0.0.18 

type OnTagCreatedConfiguration struct {
	Repository string                    `json:"repository"`
	Tags       []configuration.Predicate `json:"tags"`
}

type Repository 

type Repository struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
	URL  string `json:"url"`
}

type RunWorkflow added in v0.0.18 

type RunWorkflow struct{}

func (*RunWorkflow) Actions added in v0.0.18 

func (r *RunWorkflow) Actions() []core.Action

func (*RunWorkflow) Cancel added in v0.0.18 

func (r *RunWorkflow) Cancel(ctx core.ExecutionContext) error

func (*RunWorkflow) Color added in v0.0.18 

func (r *RunWorkflow) Color() string

func (*RunWorkflow) Configuration added in v0.0.18 

func (r *RunWorkflow) Configuration() []configuration.Field

func (*RunWorkflow) Description added in v0.0.18 

func (r *RunWorkflow) Description() string

func (*RunWorkflow) Execute added in v0.0.18 

func (r *RunWorkflow) Execute(ctx core.ExecutionContext) error

func (*RunWorkflow) HandleAction added in v0.0.18 

func (r *RunWorkflow) HandleAction(ctx core.ActionContext) error

func (*RunWorkflow) HandleWebhook added in v0.0.18 

func (r *RunWorkflow) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*RunWorkflow) Icon added in v0.0.18 

func (r *RunWorkflow) Icon() string

func (*RunWorkflow) Label added in v0.0.18 

func (r *RunWorkflow) Label() string

func (*RunWorkflow) Name added in v0.0.18 

func (r *RunWorkflow) Name() string

func (*RunWorkflow) OutputChannels added in v0.0.18 

func (r *RunWorkflow) OutputChannels(configuration any) []core.OutputChannel

func (*RunWorkflow) ProcessQueueItem added in v0.0.18 

func (r *RunWorkflow) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*RunWorkflow) Setup added in v0.0.18 

func (r *RunWorkflow) Setup(ctx core.SetupContext) error

type RunWorkflowExecutionMetadata added in v0.0.18 

type RunWorkflowExecutionMetadata struct {
	WorkflowRun *WorkflowRunMetadata `json:"workflowRun" mapstructure:"workflowRun"`
}

type RunWorkflowSpec added in v0.0.18 

type RunWorkflowSpec struct {
	Repository   string  `json:"repository"`
	WorkflowFile string  `json:"workflowFile"`
	Ref          string  `json:"ref"`
	Inputs       []Input `json:"inputs"`
}

type UpdateIssue added in v0.0.18 

type UpdateIssue struct{}

func (*UpdateIssue) Actions added in v0.0.18 

func (c *UpdateIssue) Actions() []core.Action

func (*UpdateIssue) Cancel added in v0.0.18 

func (c *UpdateIssue) Cancel(ctx core.ExecutionContext) error

func (*UpdateIssue) Color added in v0.0.18 

func (c *UpdateIssue) Color() string

func (*UpdateIssue) Configuration added in v0.0.18 

func (c *UpdateIssue) Configuration() []configuration.Field

func (*UpdateIssue) Description added in v0.0.18 

func (c *UpdateIssue) Description() string

func (*UpdateIssue) Execute added in v0.0.18 

func (c *UpdateIssue) Execute(ctx core.ExecutionContext) error

func (*UpdateIssue) HandleAction added in v0.0.18 

func (c *UpdateIssue) HandleAction(ctx core.ActionContext) error

func (*UpdateIssue) HandleWebhook added in v0.0.18 

func (c *UpdateIssue) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*UpdateIssue) Icon added in v0.0.18 

func (c *UpdateIssue) Icon() string

func (*UpdateIssue) Label added in v0.0.18 

func (c *UpdateIssue) Label() string

func (*UpdateIssue) Name added in v0.0.18 

func (c *UpdateIssue) Name() string

func (*UpdateIssue) OutputChannels added in v0.0.18 

func (c *UpdateIssue) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateIssue) ProcessQueueItem added in v0.0.18 

func (c *UpdateIssue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateIssue) Setup added in v0.0.18 

func (c *UpdateIssue) Setup(ctx core.SetupContext) error

type UpdateIssueConfiguration added in v0.0.18 

type UpdateIssueConfiguration struct {
	Repository  string   `json:"repository" mapstructure:"repository"`
	IssueNumber int      `json:"issueNumber" mapstructure:"issueNumber"`
	Title       string   `json:"title" mapstructure:"title"`
	Body        string   `json:"body" mapstructure:"body"`
	State       string   `json:"state" mapstructure:"state"`
	Assignees   []string `json:"assignees" mapstructure:"assignees"`
	Labels      []string `json:"labels" mapstructure:"labels"`
}

type Webhook 

type Webhook struct {
	ID          int64  `json:"id"`
	WebhookName string `json:"name"`
}

type WebhookConfiguration 

type WebhookConfiguration struct {
	EventType  string `json:"eventType"`
	Repository string `json:"repository"`
}

type WorkflowRunMetadata added in v0.0.18 

type WorkflowRunMetadata struct {
	ID         int64  `json:"id"`
	Status     string `json:"status"`
	Conclusion string `json:"conclusion"`
	URL        string `json:"url"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.