chocolatey

Documentation

Index

• type Dependencies
• type Dependency
• type File
• type Files
• type Metadata
• type Nuspec
  • func (m *Nuspec) Bytes() ([]byte, error)
• type Pipe
  • func (Pipe) Default(ctx *context.Context) error
  • func (Pipe) Dependencies(_ *context.Context) []string
  • 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

Types

type Dependencies

type Dependencies struct {
	Dependency []Dependency `xml:"dependency"`
}

Dependencies represents a collection zero or more dependency elements.

type Dependency

type Dependency struct {
	ID      string `xml:"id,attr"`
	Version string `xml:"version,attr,omitempty"`
}

Dependency represents a dependency element.

type File

type File struct {
	Source string `xml:"src,attr"`
	Target string `xml:"target,attr,omitempty"`
}

File represents a file to be copied.

type Files

type Files struct {
	File []File `xml:"file"`
}

Files represents files that will be copied during packaging.

type Metadata

type Metadata struct {
	ID                       string        `xml:"id"`
	Version                  string        `xml:"version"`
	PackageSourceURL         string        `xml:"packageSourceUrl,omitempty"`
	Owners                   string        `xml:"owners,omitempty"`
	Title                    string        `xml:"title,omitempty"`
	Authors                  string        `xml:"authors"`
	ProjectURL               string        `xml:"projectUrl,omitempty"`
	IconURL                  string        `xml:"iconUrl,omitempty"`
	Copyright                string        `xml:"copyright,omitempty"`
	LicenseURL               string        `xml:"licenseUrl,omitempty"`
	RequireLicenseAcceptance bool          `xml:"requireLicenseAcceptance"`
	ProjectSourceURL         string        `xml:"projectSourceUrl,omitempty"`
	DocsURL                  string        `xml:"docsUrl,omitempty"`
	BugTrackerURL            string        `xml:"bugTrackerUrl,omitempty"`
	Tags                     string        `xml:"tags,omitempty"`
	Summary                  string        `xml:"summary,omitempty"`
	Description              string        `xml:"description"`
	ReleaseNotes             string        `xml:"releaseNotes,omitempty"`
	Dependencies             *Dependencies `xml:"dependencies,omitempty"`
}

Metadata contains information about a single package.

type Nuspec

type Nuspec struct {
	XMLName  xml.Name `xml:"package"`
	Xmlns    string   `xml:"xmlns,attr,omitempty"`
	Metadata Metadata `xml:"metadata"`
	Files    Files    `xml:"files,omitempty"`
}

Nuspec represents a Nuget/Chocolatey Nuspec. More info: https://learn.microsoft.com/en-us/nuget/reference/nuspec https://docs.chocolatey.org/en-us/create/create-packages

func (*Nuspec) Bytes

func (m *Nuspec) Bytes() ([]byte, error)

Bytes marshals the Nuspec into XML format and return as []byte.

type Pipe

type Pipe struct{}

Pipe for chocolatey packaging.

func (Pipe) Default

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

Default sets the pipe defaults.

func (Pipe) Dependencies

func (Pipe) Dependencies(_ *context.Context) []string

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