deb

type PackageSpec ¶

type PackageSpec struct {
	// Binary Debian Control File - Required fields
	Package      string `json:"package"`
	Version      string `json:"-"`
	Architecture string `json:"architecture"`
	Maintainer   string `json:"maintainer"`
	Description  string `json:"description"`

	// Optional Fields
	Depends    []string `json:"depends"`
	PreDepends []string `json:"preDepends"`
	Conflicts  []string `json:"conflicts,omitempty"`
	Breaks     []string `json:"breaks,omitempty"`
	Replaces   []string `json:"replaces,omitempty"`
	Section    string   `json:"section"`  // Defaults to "default"
	Priority   string   `json:"priority"` // Defaults to "extra"
	Homepage   string   `json:"homepage"`

	// Control Scripts
	Preinst  string `json:"preinst"`
	Postinst string `json:"postinst"`
	Prerm    string `json:"prerm"`
	Postrm   string `json:"postrm"`

	// Build time options
	AutoPath         string            `json:"autoPath"` // Defaults to "deb-pkg"
	Files            map[string]string `json:"files"`
	TempPath         string            `json:"tempPath,omitempty"`
	PreserveSymlinks bool              `json:"preserveSymlinks,omitempty"`
	UpgradeConfigs   bool              `json:"upgradeConfigs,omitempty"`

	// Derived fields
	InstalledSize int64 `json:"-"` // Kilobytes, rounded up. Derived from file sizes.
}

PackageSpec is parsed from JSON and initializes both build time parameters and the metadata inside the .deb package.

Required Fields ¶

The following fields are required by the debian package specification:

Package is the name of your package, and typically matches the name of your main program.

Version is a debian version string. See the reference for more details. This field is not currently validated except to verify that it is specified, but if the syntax is invalid you will not be able to install the package.

Architecture is the CPU architecture your package is compiled for. If your package does not include a compiled binary you can set this to "all".

Maintainer should indicate contact information for the package, such as Chris Bednarski <chris@example.com>

Description should briefly explain what your package is used for. Only a single line is currently supported.

Optional Fields ¶

Depends is used to specify whether your package depends on other packages. Dependencies should be specified using the following syntax

"depends": [
    "curl (>= 7.0.0)",
    "python (= 2.7.12)",
    "tree"
]

Conflicts, Breaks, and Replaces work in a very similar way. For additional information on when you should use optional fields and how to specify them, refer to the debian package specification.

Homepage should link to your package's source repository, if applicable. Otherwise link to your website.

Control Scripts ¶

You may need to perform additional setup (or cleanup) when (un)installing a package. You can do this through the control scripts: preinst, postinst, prerm, and postrm.

These are commonly used to create users, start or stop services, or perform cleanup when a package is uninstalled.

AutoPath ¶

The Build method is designed to automatically fill in most of the build configuration based on files it finds on the filesystem. If AutoPath is set to a non-empty value it will be scanned for pre/post/inst/rm scripts as well as configuration files and binaries to be automatically included in the .deb.

To disable the automatic behavior set AutoPath to an empty string or dash "-". Whether or not AutoPath is used you may supplement the list of files to be included by specifying the Files field.

Build Time Options ¶

TempPath controls where intermediate files are written during the build. This defaults to the system temp directory (usually /tmp).

UpgradeConfigs causes a package upgrade to replace all of the config files. By default files under /etc are left as-is when upgrading a package so you can keep changes made to your config files, but if you want to upgrade the config files themselves you will need to set UpgradeConfigs to true.

PreserveSymlinks writes symlinks to the archive. By default the contents of the file the symlink is pointing to is copied into the .deb package.

Derived Fields ¶

InstalledSize is calculated based on the total size of your files and control scripts. You should not specify this yourself.

For details on how to use pre/post/inst/rm and various .deb-specific fields please refere to the debian package specification:

https://www.debian.org/doc/debian-policy/ch-controlfields.html

https://www.debian.org/doc/manuals/debian-faq/ch-pkg_basics.en.html

func DefaultPackageSpec() *PackageSpec

func NewPackageSpecFromFile(filename string) (*PackageSpec, error)

func NewPackageSpecFromJSON(data []byte) (*PackageSpec, error)

func (p *PackageSpec) Build(target string) error

path.Join(target, PackageSpec.Filename())

func (p *PackageSpec) CalculateChecksums() ([]byte, error)

checksum  file1
checksum  file2

func (p *PackageSpec) CalculateSize() (int64, error)

func (p *PackageSpec) CreateControlArchive(target string) error

conffiles
md5sums
control
pre/post/inst/rm scripts (if any)

func (p *PackageSpec) CreateDataArchive(target string) error

func (p *PackageSpec) Filename() string

func (p *PackageSpec) ListEtcFiles() ([]string, error)

func (p *PackageSpec) ListFiles(includeDirs bool) ([]string, error)

func (p *PackageSpec) MapControlFiles() map[string]string

func (p *PackageSpec) NormalizeFilename(filename string) (string, error)

func (p *PackageSpec) RenderControlFile() ([]byte, error)

func (p *PackageSpec) Validate(buildTime bool) error