nfpm

README

nFPM

nFPM is a simple, 0-dependencies, deb, rpm and apk packager.

Why

While fpm is great, for me, it is a bummer that it depends on ruby, tar and other software.

I wanted something that could be used as a binary and/or as a library and that was really simple.

So I created nFPM: a simpler, 0-dependency, as-little-assumptions-as-possible alternative to fpm.

Usage

Check the documentation at https://nfpm.goreleaser.com

Special thanks 🙏

Thanks to the fpm authors for fpm, which inspires nfpm a lot.

Donate

Donations are very much appreciated! You can donate/sponsor on the main goreleaser opencollective! It's easy and will surely help the developers at least buy some ☕️ or 🍺!

Stargazers over time

---

Would you like to fix something in the documentation? Feel free to open an issue.

Documentation

Overview

Package nfpm provides ways to package programs in some linux packaging formats.

Index

• func ClearPackagers()
• func RegisterPackager(format string, p Packager)
• func Validate(info *Info) (err error)
• type APK
• type APKScripts
• type APKSignature
• type Config
  • func Parse(in io.Reader) (config Config, err error)
  • func ParseFile(path string) (config Config, err error)
  • func ParseFileWithEnvMapping(path string, mapping func(string) string) (config Config, err error)
  • func ParseWithEnvMapping(in io.Reader, mapping func(string) string) (config Config, err error)
  • func (c *Config) Get(format string) (info *Info, err error)
  • func (c *Config) Validate() error
• type Deb
• type DebScripts
• type DebSignature
• type DebTriggers
• type ErrFieldEmpty
  • func (e ErrFieldEmpty) Error() string
• type ErrNoPackager
  • func (e ErrNoPackager) Error() string
• type ErrSigningFailure
  • func (s *ErrSigningFailure) Error() string
  • func (s *ErrSigningFailure) Unwarp() error
• type Info
  • func WithDefaults(info *Info) *Info
  • func (i *Info) GetChangeLog() (log *chglog.PackageChangeLog, err error)
  • func (i *Info) Validate() error
• type Overridables
• type PackageSignature
• type Packager
  • func Get(format string) (Packager, error)
• type RPM
• type RPMScripts
• type RPMSignature
• type Scripts

Functions

func ClearPackagers

func ClearPackagers()

ClearPackagers clear all registered packagers, used for testing.

func RegisterPackager

func RegisterPackager(format string, p Packager)

RegisterPackager a new packager for the given format.

func Validate

func Validate(info *Info) (err error)

Validate the given Info and returns an error if it is invalid.

Types

type APK

type APK struct {
	Arch      string       `yaml:"arch,omitempty" jsonschema:"title=architecture in apk nomenclature"`
	Signature APKSignature `yaml:"signature,omitempty" jsonschema:"title=apk signature"`
	Scripts   APKScripts   `yaml:"scripts,omitempty" jsonschema:"title=apk scripts"`
}

type APKScripts

type APKScripts struct {
	PreUpgrade  string `yaml:"preupgrade,omitempty" jsonschema:"title=pre upgrade script"`
	PostUpgrade string `yaml:"postupgrade,omitempty" jsonschema:"title=post upgrade script"`
}

type APKSignature

type APKSignature struct {
	PackageSignature `yaml:",inline"`
	// defaults to <maintainer email>.rsa.pub
	KeyName string `yaml:"key_name,omitempty" jsonschema:"title=key name,example=origin,default=maintainer_email.rsa.pub"`
}

type Config

type Config struct {
	Info      `yaml:",inline"`
	Overrides map[string]Overridables `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Config contains the top level configuration for packages.

func Parse

func Parse(in io.Reader) (config Config, err error)

Parse decodes YAML data from an io.Reader into a configuration struct.

func ParseFile

func ParseFile(path string) (config Config, err error)

ParseFile decodes YAML data from a file path into a configuration struct.

func ParseFileWithEnvMapping

func ParseFileWithEnvMapping(path string, mapping func(string) string) (config Config, err error)

ParseFileWithEnvMapping decodes YAML data from a file path into a configuration struct.

func ParseWithEnvMapping

func ParseWithEnvMapping(in io.Reader, mapping func(string) string) (config Config, err error)

ParseWithEnvMapping decodes YAML data from an io.Reader into a configuration struct.

func (*Config) Get

func (c *Config) Get(format string) (info *Info, err error)

Get returns the Info struct for the given packager format. Overrides for the given format are merged into the final struct.

func (*Config) Validate

func (c *Config) Validate() error

Validate ensures that the config is well typed.

type Deb

type Deb struct {
	Arch        string       `yaml:"arch,omitempty" jsonschema:"title=architecture in deb nomenclature"`
	Scripts     DebScripts   `yaml:"scripts,omitempty" jsonschema:"title=scripts"`
	Triggers    DebTriggers  `yaml:"triggers,omitempty" jsonschema:"title=triggers"`
	Breaks      []string     `yaml:"breaks,omitempty" jsonschema:"title=breaks"`
	Signature   DebSignature `yaml:"signature,omitempty" jsonschema:"title=signature"`
	Compression string       `yaml:"compression,omitempty" jsonschema:"title=compression algorithm to be used,enum=gzip,enum=xz,enum=none,default=gzip"`
}

Deb is custom configs that are only available on deb packages.

type DebScripts

type DebScripts struct {
	Rules     string `yaml:"rules,omitempty" jsonschema:"title=rules"`
	Templates string `yaml:"templates,omitempty" jsonschema:"title=templates"`
	Config    string `yaml:"config,omitempty" jsonschema:"title=config"`
}

DebScripts is scripts only available on deb packages.

type DebSignature

type DebSignature struct {
	PackageSignature `yaml:",inline"`
	// origin, maint or archive (defaults to origin)
	Type string `yaml:"type,omitempty" jsonschema:"title=signer role,enum=origin,enum=maint,enum=archive,default=origin"`
}

type DebTriggers

type DebTriggers struct {
	Interest        []string `yaml:"interest,omitempty" jsonschema:"title=interest"`
	InterestAwait   []string `yaml:"interest_await,omitempty" jsonschema:"title=interest await"`
	InterestNoAwait []string `yaml:"interest_noawait,omitempty" jsonschema:"title=interest noawait"`
	Activate        []string `yaml:"activate,omitempty" jsonschema:"title=activate"`
	ActivateAwait   []string `yaml:"activate_await,omitempty" jsonschema:"title=activate await"`
	ActivateNoAwait []string `yaml:"activate_noawait,omitempty" jsonschema:"title=activate noawait"`
}

DebTriggers contains triggers only available for deb packages. https://wiki.debian.org/DpkgTriggers https://man7.org/linux/man-pages/man5/deb-triggers.5.html

type ErrFieldEmpty

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

ErrFieldEmpty happens when some required field is empty.

func (ErrFieldEmpty) Error

func (e ErrFieldEmpty) Error() string

type ErrNoPackager

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

ErrNoPackager happens when no packager is registered for the given format.

func (ErrNoPackager) Error

func (e ErrNoPackager) Error() string

type ErrSigningFailure

type ErrSigningFailure struct {
	Err error
}

ErrSigningFailure is returned whenever something went wrong during the package signing process. The underlying error can be unwrapped and could be crypto-related or something that occurred while adding the signature to the package.

func (*ErrSigningFailure) Error

func (s *ErrSigningFailure) Error() string

func (*ErrSigningFailure) Unwarp

func (s *ErrSigningFailure) Unwarp() error

type Info

type Info struct {
	Overridables    `yaml:",inline"`
	Name            string `yaml:"name" jsonschema:"title=package name"`
	Arch            string `yaml:"arch" jsonschema:"title=target architecture,example=amd64"`
	Platform        string `yaml:"platform,omitempty" jsonschema:"title=target platform,example=linux,default=linux"`
	Epoch           string `yaml:"epoch,omitempty" jsonschema:"title=version epoch,example=2,default=extracted from version"`
	Version         string `yaml:"version" jsonschema:"title=version,example=v1.0.2,example=2.0.1"`
	VersionSchema   string `yaml:"version_schema,omitempty" jsonschema:"title=version schema,enum=semver,enum=none,default=semver"`
	Release         string `yaml:"release,omitempty" jsonschema:"title=version release,example=1"`
	Prerelease      string `yaml:"prerelease,omitempty" jsonschema:"title=version prerelease,default=extracted from version"`
	VersionMetadata string `yaml:"version_metadata,omitempty" jsonschema:"title=version metadata,example=git"`
	Section         string `yaml:"section,omitempty" jsonschema:"title=package section,example=default"`
	Priority        string `yaml:"priority,omitempty" jsonschema:"title=package priority,example=extra"`
	Maintainer      string `yaml:"maintainer,omitempty" jsonschema:"title=package maintainer,example=me@example.com"`
	Description     string `yaml:"description,omitempty" jsonschema:"title=package description"`
	Vendor          string `yaml:"vendor,omitempty" jsonschema:"title=package vendor,example=MyCorp"`
	Homepage        string `yaml:"homepage,omitempty" jsonschema:"title=package homepage,example=https://example.com"`
	License         string `yaml:"license,omitempty" jsonschema:"title=package license,example=MIT"`
	Changelog       string `` /* 156-byte string literal not displayed */
	DisableGlobbing bool   `yaml:"disable_globbing,omitempty" jsonschema:"title=wether to disable file globbing,default=false"`
	Target          string `yaml:"-"`
}

Info contains information about a single package.

func WithDefaults

func WithDefaults(info *Info) *Info

WithDefaults set some sane defaults into the given Info.

func (*Info) GetChangeLog

func (i *Info) GetChangeLog() (log *chglog.PackageChangeLog, err error)

GetChangeLog parses the provided changelog file.

func (*Info) Validate

func (i *Info) Validate() error

type Overridables

type Overridables struct {
	Replaces     []string       `yaml:"replaces,omitempty" jsonschema:"title=replaces directive,example=nfpm"`
	Provides     []string       `yaml:"provides,omitempty" jsonschema:"title=provides directive,example=nfpm"`
	Depends      []string       `yaml:"depends,omitempty" jsonschema:"title=depends directive,example=nfpm"`
	Recommends   []string       `yaml:"recommends,omitempty" jsonschema:"title=recommends directive,example=nfpm"`
	Suggests     []string       `yaml:"suggests,omitempty" jsonschema:"title=suggests directive,example=nfpm"`
	Conflicts    []string       `yaml:"conflicts,omitempty" jsonschema:"title=conflicts directive,example=nfpm"`
	Contents     files.Contents `yaml:"contents,omitempty" jsonschema:"title=files to add to the package"`
	EmptyFolders []string       `` /* 127-byte string literal not displayed */
	Scripts      Scripts        `yaml:"scripts,omitempty" jsonschema:"title=scripts to execute"`
	RPM          RPM            `yaml:"rpm,omitempty" jsonschema:"title=rpm-specific settings"`
	Deb          Deb            `yaml:"deb,omitempty" jsonschema:"title=deb-specific settings"`
	APK          APK            `yaml:"apk,omitempty" jsonschema:"title=apk-specific settings"`
}

Overridables contain the field which are overridable in a package.

type PackageSignature

type PackageSignature struct {
	// PGP secret key, can be ASCII-armored
	KeyFile       string  `yaml:"key_file,omitempty" jsonschema:"title=key file,example=key.gpg"`
	KeyID         *string `yaml:"key_id,omitempty" jsonschema:"title=key id,example=bc8acdd415bd80b3"`
	KeyPassphrase string  `yaml:"-"` // populated from environment variable
}

type Packager

type Packager interface {
	Package(info *Info, w io.Writer) error
	ConventionalFileName(info *Info) string
}

Packager represents any packager implementation.

func Get

func Get(format string) (Packager, error)

Get a packager for the given format.

type RPM

type RPM struct {
	Arch        string       `yaml:"arch,omitempty" jsonschema:"title=architecture in rpm nomenclature"`
	Scripts     RPMScripts   `yaml:"scripts,omitempty" jsonschema:"title=rpm-specific scripts"`
	Group       string       `yaml:"group,omitempty" jsonschema:"title=package group,example=Unspecified"`
	Summary     string       `yaml:"summary,omitempty" jsonschema:"title=package summary"`
	Compression string       `yaml:"compression,omitempty" jsonschema:"title=compression algorithm to be used,enum=gzip,enum=lzma,enum=xz,default=gzip"`
	Signature   RPMSignature `yaml:"signature,omitempty" jsonschema:"title=rpm signature"`
}

RPM is custom configs that are only available on RPM packages.

type RPMScripts

type RPMScripts struct {
	PreTrans  string `yaml:"pretrans,omitempty" jsonschema:"title=pretrans script"`
	PostTrans string `yaml:"posttrans,omitempty" jsonschema:"title=posttrans script"`
}

RPMScripts represents scripts only available on RPM packages.

type RPMSignature

type RPMSignature struct {
	PackageSignature `yaml:",inline"`
}

type Scripts

type Scripts struct {
	PreInstall  string `yaml:"preinstall,omitempty" jsonschema:"title=pre install"`
	PostInstall string `yaml:"postinstall,omitempty" jsonschema:"title=post install"`
	PreRemove   string `yaml:"preremove,omitempty" jsonschema:"title=pre remove"`
	PostRemove  string `yaml:"postremove,omitempty" jsonschema:"title=post remove"`
}

Scripts contains information about maintainer scripts for packages.