native

Documentation

Overview

Package native provides the ability for Vela to reconstruct a yaml configuration into an executable pipeline.

Usage:

import "github.com/go-vela/compiler/compiler/native"

Index

• func New(ctx *cli.Context) (*client, error)
• func ParseBytes(b []byte) (*types.Build, error)
• func ParseFile(f *os.File) (*types.Build, error)
• func ParseFileRaw(f *os.File) (string, error)
• func ParsePath(p string) (*types.Build, error)
• func ParsePathRaw(p string) (string, error)
• func ParseReader(r io.Reader) (*types.Build, error)
• func ParseReaderRaw(r io.Reader) (string, error)
• func ParseString(s string) (*types.Build, error)
• type ModificationConfig
• type ModifyRequest
• type ModifyResponse

Functions

func New

func New(ctx *cli.Context) (*client, error)

New returns a Pipeline implementation that integrates with the supported registries.

nolint: revive // ignore returning unexported client

func ParseBytes

func ParseBytes(b []byte) (*types.Build, error)

ParseBytes converts a byte slice to a yaml configuration.

func ParseFile

func ParseFile(f *os.File) (*types.Build, error)

ParseFile converts an os.File into a yaml configuration.

func ParseFileRaw

func ParseFileRaw(f *os.File) (string, error)

ParseFileRaw converts an os.File into a string.

func ParsePath

func ParsePath(p string) (*types.Build, error)

ParsePath converts a file path into a yaml configuration.

func ParsePathRaw

func ParsePathRaw(p string) (string, error)

ParsePathRaw converts a file path into a yaml configuration.

func ParseReader

func ParseReader(r io.Reader) (*types.Build, error)

ParseReader converts an io.Reader into a yaml configuration.

func ParseReaderRaw

func ParseReaderRaw(r io.Reader) (string, error)

ParseReaderRaw converts an io.Reader into a yaml configuration.

func ParseString

func ParseString(s string) (*types.Build, error)

ParseString converts a string into a yaml configuration.

Types

type ModificationConfig

type ModificationConfig struct {
	Timeout  time.Duration
	Retries  int
	Endpoint string
	Secret   string
}

type ModifyRequest

type ModifyRequest struct {
	Pipeline string `json:"pipeline,omitempty"`
	Build    int    `json:"build,omitempty"`
	Repo     string `json:"repo,omitempty"`
	Org      string `json:"org,omitempty"`
	User     string `json:"user,omitempty"`
}

ModifyRequest contains the payload passed to the modification endpoint.

type ModifyResponse

type ModifyResponse struct {
	Pipeline string `json:"pipeline,omitempty"`
}

ModifyResponse contains the payload returned by the modification endpoint.