manifest

package

v0.0.0-...-b94449b Latest Latest Go to latest Published: Sep 17, 2021 License: AGPL-3.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jeffrom/polyester

Links

Open Source Insights

Documentation ¶

Overview ¶

Package manifest contains functions to save and load manifests.

Manifests are pre-"compiled" collections of scripts, templates, and files that can be read and written to and from disk, and can also be compiled and executed on a host.

Index ¶

func Save(m *Manifest, destDir string) (string, error)
func SaveDir(dir string, m *Manifest) error
type Manifest
- func (m *Manifest) Validate() error
type Metadata

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Save ¶

func Save(m *Manifest, destDir string) (string, error)

func SaveDir ¶

func SaveDir(dir string, m *Manifest) error

Types ¶

type Manifest ¶

type Manifest struct {
	Metadata   *Metadata            `json:"metadata,omitempty"`
	Main       string               `json:"main,omitempty"`
	MainScript []byte               `json:"main_script,omitempty"`
	Plans      map[string]*Manifest `json:"plans,omitempty"`
	Files      map[string][]byte    `json:"files,omitempty"`
	Templates  map[string][]byte    `json:"templates,omitempty"`
	Vars       map[string][]byte    `json:"vars,omitempty"`
	Secrets    map[string][]byte    `json:"secrets,omitempty"`
}

func LoadArchive ¶

func LoadArchive(r io.Reader) (*Manifest, error)

func LoadDir ¶

func LoadDir(dir string) (*Manifest, error)

func LoadFS ¶

func LoadFS(mfs fs.FS) (*Manifest, error)

func LoadFile ¶

func LoadFile(name string) (*Manifest, error)

func (*Manifest) Validate ¶

func (m *Manifest) Validate() error

type Metadata ¶

type Metadata struct {
	Name    string `json:"name,omitempty"`
	Version string `json:"version,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL