actions

package

v0.19.0 Latest Latest Go to latest Published: May 4, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

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

Repository

github.com/superplanehq/superplane

Links

Open Source Insights

Documentation ¶

Constants ¶

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 ¶

This section is empty.

Types ¶

type Input ¶

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

type OnWorkflowRun ¶

type OnWorkflowRun struct{}

func (*OnWorkflowRun) Cleanup ¶

func (w *OnWorkflowRun) Cleanup(ctx core.TriggerContext) error

func (*OnWorkflowRun) Color ¶

func (w *OnWorkflowRun) Color() string

func (*OnWorkflowRun) Configuration ¶

func (w *OnWorkflowRun) Configuration() []configuration.Field

func (*OnWorkflowRun) Description ¶

func (w *OnWorkflowRun) Description() string

func (*OnWorkflowRun) Documentation ¶

func (w *OnWorkflowRun) Documentation() string

func (*OnWorkflowRun) ExampleData ¶

func (t *OnWorkflowRun) ExampleData() map[string]any

func (*OnWorkflowRun) HandleHook ¶

func (w *OnWorkflowRun) HandleHook(ctx core.TriggerHookContext) (map[string]any, error)

func (*OnWorkflowRun) HandleWebhook ¶

func (w *OnWorkflowRun) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*OnWorkflowRun) Hooks ¶

func (w *OnWorkflowRun) Hooks() []core.Hook

func (*OnWorkflowRun) Icon ¶

func (w *OnWorkflowRun) Icon() string

func (*OnWorkflowRun) Label ¶

func (w *OnWorkflowRun) Label() string

func (*OnWorkflowRun) Name ¶

func (w *OnWorkflowRun) Name() string

func (*OnWorkflowRun) Setup ¶

func (w *OnWorkflowRun) Setup(ctx core.TriggerContext) error

type OnWorkflowRunConfiguration ¶

type OnWorkflowRunConfiguration struct {
	Repository    string   `json:"repository" mapstructure:"repository"`
	Conclusions   []string `json:"conclusions" mapstructure:"conclusions"`
	WorkflowFiles []string `json:"workflowFiles" mapstructure:"workflowFiles"`
}

type RunWorkflow ¶

type RunWorkflow struct{}

func (*RunWorkflow) Cancel ¶

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

func (*RunWorkflow) Cleanup ¶

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

func (*RunWorkflow) Color ¶

func (r *RunWorkflow) Color() string

func (*RunWorkflow) Configuration ¶

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

func (*RunWorkflow) Description ¶

func (r *RunWorkflow) Description() string

func (*RunWorkflow) Documentation ¶

func (r *RunWorkflow) Documentation() string

func (*RunWorkflow) ExampleOutput ¶

func (c *RunWorkflow) ExampleOutput() map[string]any

func (*RunWorkflow) Execute ¶

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

func (*RunWorkflow) HandleHook ¶

func (r *RunWorkflow) HandleHook(ctx core.ActionHookContext) error

func (*RunWorkflow) HandleWebhook ¶

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

func (*RunWorkflow) Hooks ¶

func (r *RunWorkflow) Hooks() []core.Hook

func (*RunWorkflow) Icon ¶

func (r *RunWorkflow) Icon() string

func (*RunWorkflow) Label ¶

func (r *RunWorkflow) Label() string

func (*RunWorkflow) Name ¶

func (r *RunWorkflow) Name() string

func (*RunWorkflow) OutputChannels ¶

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

func (*RunWorkflow) ProcessQueueItem ¶

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

func (*RunWorkflow) Setup ¶

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

type RunWorkflowExecutionMetadata ¶

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

type RunWorkflowSpec ¶

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

type WorkflowRunMetadata ¶

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

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