parser

Documentation

Index

• func Check(ctx context.Context, parser Parser, m *yaml.Node) error
• func List() []string
• func Pin(ctx context.Context, res resolver.Resolver, parser Parser, m *yaml.Node, ...) error
• func Unpin(m *yaml.Node) error
• type Actions
  • func (a *Actions) Parse(m *yaml.Node) (*RefsList, error)
• type CircleCI
  • func (C *CircleCI) Parse(m *yaml.Node) (*RefsList, error)
• type CloudBuild
  • func (c *CloudBuild) Parse(m *yaml.Node) (*RefsList, error)
• type Parser
  • func For(ctx context.Context, name string) (Parser, error)
• type RefsList
  • func (l *RefsList) Add(ref string, m *yaml.Node)
  • func (l *RefsList) All() map[string][]*yaml.Node
  • func (l *RefsList) Refs() []string

Functions

func Check

func Check(ctx context.Context, parser Parser, m *yaml.Node) error

Check iterates over all references in the yaml and checks if they are pinned to an absolute reference. It ignores "ratchet:exclude" nodes from the lookup.

func List

func List() []string

List returns the list of parsers.

func Pin

func Pin(ctx context.Context, res resolver.Resolver, parser Parser, m *yaml.Node, concurrency uint64) error

Pin extracts all references from the given YAML document and resolves them using the given resolver, updating the associated YAML nodes.

func Unpin

func Unpin(m *yaml.Node) error

Unpin removes any pinned references and updates the actual YAML to be the original reference, leaving any other comment intact. This effectively replaces the YAML with the cached comment, which could result in losing the current pin.

This function does not make any outbound network calls and relies solely on information in the document.

Types

type Actions

type Actions struct{}

func (*Actions) Parse

func (a *Actions) Parse(m *yaml.Node) (*RefsList, error)

Parse pulls the GitHub Actions refs from the document.

type CircleCI

type CircleCI struct{}

func (*CircleCI) Parse

func (C *CircleCI) Parse(m *yaml.Node) (*RefsList, error)

Parse pulls the CircleCI refs from the document. Unfortunately it does not process "orbs" because there is no documented API for resolving orbs to an absolute version.

type CloudBuild

type CloudBuild struct{}

func (*CloudBuild) Parse

func (c *CloudBuild) Parse(m *yaml.Node) (*RefsList, error)

Parse pulls the Google Cloud Buidl refs from the document.

type Parser

type Parser interface {
	Parse(m *yaml.Node) (*RefsList, error)
}

Parser defines an interface which parses references out of the given yaml node.

func For

func For(ctx context.Context, name string) (Parser, error)

For returns the parser that corresponds to the given name.

type RefsList

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

func (*RefsList) Add

func (l *RefsList) Add(ref string, m *yaml.Node)

func (*RefsList) All

func (l *RefsList) All() map[string][]*yaml.Node

func (*RefsList) Refs

func (l *RefsList) Refs() []string