scoop

Documentation

Overview

Package scoop provides a Pipe that generates a scoop.sh App Manifest and pushes it to a bucket

Index

• type ErrNoWindows
  • func (e ErrNoWindows) Error() string
• type Manifest
• 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
• type Resource

Types

type ErrNoWindows

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

ErrNoWindows when there is no build for windows (goos doesn't contain windows) or archive.format is binary.

func (ErrNoWindows) Error

func (e ErrNoWindows) Error() string

type Manifest

type Manifest struct {
	Version      string              `json:"version"`                // The version of the app that this manifest installs.
	Architecture map[string]Resource `json:"architecture"`           // `architecture`: If the app has 32- and 64-bit versions, architecture can be used to wrap the differences.
	Homepage     string              `json:"homepage,omitempty"`     // `homepage`: The home page for the program.
	License      string              `json:"license,omitempty"`      // `license`: The software license for the program. For well-known licenses, this will be a string like "MIT" or "GPL2". For custom licenses, this should be the URL of the license.
	Description  string              `json:"description,omitempty"`  // Description of the app
	Persist      []string            `json:"persist,omitempty"`      // Persist data between updates
	PreInstall   []string            `json:"pre_install,omitempty"`  // An array of strings, of the commands to be executed before an application is installed.
	PostInstall  []string            `json:"post_install,omitempty"` // An array of strings, of the commands to be executed after an application is installed.
	Depends      []string            `json:"depends,omitempty"`      // A string or an array of strings.
	Shortcuts    [][]string          `json:"shortcuts,omitempty"`    // A two-dimensional array of string, specifies the shortcut values to make available in the startmenu.
}

Manifest represents a scoop.sh App Manifest. more info: https://github.com/lukesampson/scoop/wiki/App-Manifests

type Pipe

type Pipe struct{}

Pipe that builds and publishes scoop manifests.

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 scoop manifest.

func (Pipe) Run

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

Run creates the scoop manifest locally.

func (Pipe) Skip

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

func (Pipe) String

func (Pipe) String() string

type Resource

type Resource struct {
	URL  string   `json:"url"`  // URL to the archive
	Bin  []string `json:"bin"`  // name of binary inside the archive
	Hash string   `json:"hash"` // the archive checksum
}

Resource represents a combination of a url and a binary name for an architecture.