step

Documentation

Overview

Package step provides the step handlers for the Vela API.

Usage:

import "github.com/go-vela/server/api/step"

Index

• func CreateStep(c *gin.Context)
• func DeleteStep(c *gin.Context)
• func GetStep(c *gin.Context)
• func ListSteps(c *gin.Context)
• func PlanSteps(ctx context.Context, database database.Interface, p *pipeline.Build, ...) ([]*library.Step, error)
• func UpdateStep(c *gin.Context)

Functions

func CreateStep

func CreateStep(c *gin.Context)

CreateStep represents the API handler to create a step for a build in the configured backend.

func DeleteStep

func DeleteStep(c *gin.Context)

DeleteStep represents the API handler to remove a step for a build from the configured backend.

func GetStep

func GetStep(c *gin.Context)

GetStep represents the API handler to capture a step for a build from the configured backend.

func ListSteps

func ListSteps(c *gin.Context)

ListSteps represents the API handler to capture a list of steps for a build from the configured backend.

func PlanSteps

func PlanSteps(ctx context.Context, database database.Interface, p *pipeline.Build, b *library.Build) ([]*library.Step, error)

PlanSteps is a helper function to plan all steps in the build for execution. This creates the steps for the build in the configured backend.

func UpdateStep

func UpdateStep(c *gin.Context)

UpdateStep represents the API handler to update a step for a build in the configured backend.