snapcraft

Documentation

Overview

Package snapcraft implements the Pipe interface providing Snapcraft bindings.

nolint:tagliatelle

Index

• Variables
• type AppMetadata
• type LayoutMetadata
• type Metadata
• type Pipe
  • func (Pipe) Default(ctx *context.Context) error
  • func (Pipe) Publish(ctx *context.Context) error
  • func (Pipe) Run(ctx *context.Context) error
  • func (Pipe) Skip(ctx *context.Context) bool
  • func (Pipe) String() string

Variables

var ErrNoDescription = errors.New("no description provided for snapcraft")

ErrNoDescription is shown when no description provided.

var ErrNoSnapcraft = errors.New("snapcraft not present in $PATH")

ErrNoSnapcraft is shown when snapcraft cannot be found in $PATH.

var ErrNoSummary = errors.New("no summary provided for snapcraft")

ErrNoSummary is shown when no summary provided.

Types

type AppMetadata

type AppMetadata struct {
	Command string

	Adapter          string                 `yaml:",omitempty"`
	After            []string               `yaml:",omitempty"`
	Aliases          []string               `yaml:",omitempty"`
	Autostart        string                 `yaml:",omitempty"`
	Before           []string               `yaml:",omitempty"`
	BusName          string                 `yaml:"bus-name,omitempty"`
	CommandChain     []string               `yaml:"command-chain,omitempty"`
	CommonID         string                 `yaml:"common-id,omitempty"`
	Completer        string                 `yaml:",omitempty"`
	Daemon           string                 `yaml:",omitempty"`
	Desktop          string                 `yaml:",omitempty"`
	Environment      map[string]interface{} `yaml:",omitempty"`
	Extensions       []string               `yaml:",omitempty"`
	InstallMode      string                 `yaml:"install-mode,omitempty"`
	Passthrough      map[string]interface{} `yaml:",omitempty"`
	Plugs            []string               `yaml:",omitempty"`
	PostStopCommand  string                 `yaml:"post-stop-command,omitempty"`
	RefreshMode      string                 `yaml:"refresh-mode,omitempty"`
	ReloadCommand    string                 `yaml:"reload-command,omitempty"`
	RestartCondition string                 `yaml:"restart-condition,omitempty"`
	RestartDelay     string                 `yaml:"restart-delay,omitempty"`
	Slots            []string               `yaml:",omitempty"`
	Sockets          map[string]interface{} `yaml:",omitempty"`
	StartTimeout     string                 `yaml:"start-timeout,omitempty"`
	StopCommand      string                 `yaml:"stop-command,omitempty"`
	StopMode         string                 `yaml:"stop-mode,omitempty"`
	StopTimeout      string                 `yaml:"stop-timeout,omitempty"`
	Timer            string                 `yaml:",omitempty"`
	WatchdogTimeout  string                 `yaml:"watchdog-timeout,omitempty"`
}

AppMetadata for the binaries that will be in the snap package. See: https://snapcraft.io/docs/snapcraft-app-and-service-metadata

type LayoutMetadata

type LayoutMetadata struct {
	Symlink  string `yaml:",omitempty"`
	Bind     string `yaml:",omitempty"`
	BindFile string `yaml:"bind-file,omitempty"`
	Type     string `yaml:",omitempty"`
}

type Metadata

type Metadata struct {
	Name          string
	Version       string
	Summary       string
	Description   string
	Base          string `yaml:",omitempty"`
	License       string `yaml:",omitempty"`
	Grade         string `yaml:",omitempty"`
	Confinement   string `yaml:",omitempty"`
	Architectures []string
	Layout        map[string]LayoutMetadata `yaml:",omitempty"`
	Apps          map[string]AppMetadata
	Plugs         map[string]interface{} `yaml:",omitempty"`
}

Metadata to generate the snap package.

type Pipe

type Pipe struct{}

Pipe for snapcraft packaging.

func (Pipe) Default

func (Pipe) Default(ctx *context.Context) error

Default sets the pipe defaults.

func (Pipe) Publish

func (Pipe) Publish(ctx *context.Context) error

Publish packages.

func (Pipe) Run

func (Pipe) Run(ctx *context.Context) error

Run the pipe.

func (Pipe) Skip

func (Pipe) Skip(ctx *context.Context) bool

func (Pipe) String

func (Pipe) String() string