nfpm

README

NFPM

NFPM is Not FPM - a simple deb and rpm packager written in Go.

Why

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

I wanted something that could be used as a binary and/or as a lib on go-software, so I hacked this together and it works!

Goals

• be simple to use
• provide packaging for the most common linux packaging systems (at very least deb and rpm)
• be distributed as a single binary
• reproducible results
  • depend on the fewer external things as possible (namely rpmbuild)
  • generate packages based on yaml files (maybe also json and toml?)
• be possible to use it as a lib in other go projects (namely goreleaser itself)
• support complex packages and power users

Usage

The first steps are to run nfpm init to initialize a config file and edit the generated file according to your needs:

The next step is to run nfpm pkg --target mypkg.deb. NFPM will guess which packager to use based on the target file extension.

And that's it!

Usage as lib

You can look at the code of nfpm itself to see how to use it as a library, or, take a look at the nfpm piper on GoReleaser.

Attention: GoReleaser deb packager only compiles with go1.10+.

Status

• both deb and rpm packaging are working but there are some missing features.

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 Register(format string, p Packager)
• func Validate(info Info) error
• type Info
  • func WithDefaults(info Info) Info
• type Packager
  • func Get(format string) (Packager, error)
• type Scripts

Functions

func Register

func Register(format string, p Packager)

Register a new packager for the given format

func Validate

func Validate(info Info) error

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

Types

type Info

type Info struct {
	Name        string            `yaml:"name,omitempty"`
	Arch        string            `yaml:"arch,omitempty"`
	Platform    string            `yaml:"platform,omitempty"`
	Version     string            `yaml:"version,omitempty"`
	Section     string            `yaml:"section,omitempty"`
	Priority    string            `yaml:"priority,omitempty"`
	Replaces    []string          `yaml:"replaces,omitempty"`
	Provides    []string          `yaml:"provides,omitempty"`
	Depends     []string          `yaml:"depends,omitempty"`
	Recommends  []string          `yaml:"recommends,omitempty"`
	Suggests    []string          `yaml:"suggests,omitempty"`
	Conflicts   []string          `yaml:"conflicts,omitempty"`
	Maintainer  string            `yaml:"maintainer,omitempty"`
	Description string            `yaml:"description,omitempty"`
	Vendor      string            `yaml:"vendor,omitempty"`
	Homepage    string            `yaml:"homepage,omitempty"`
	License     string            `yaml:"license,omitempty"`
	Bindir      string            `yaml:"bindir,omitempty"`
	Files       map[string]string `yaml:"files,omitempty"`
	ConfigFiles map[string]string `yaml:"config_files,omitempty"`
	Scripts     Scripts           `yaml:"scripts,omitempty"`
}

Info contains information about the package

func WithDefaults

func WithDefaults(info Info) Info

WithDefaults set some sane defaults into the given Info

type Packager

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

Packager represents any packager implementation

func Get

func Get(format string) (Packager, error)

Get a packager for the given format

type Scripts

type Scripts struct {
	PreInstall  string `yaml:"preinstall,omitempty"`
	PostInstall string `yaml:"postinstall,omitempty"`
	PreRemove   string `yaml:"preremove,omitempty"`
	PostRemove  string `yaml:"postremove,omitempty"`
}

Scripts contains information about maintainer scripts for packages