1
1
mirror of https://github.com/goreleaser/nfpm synced 2024-09-28 07:30:08 +02:00
NFPM is Not FPM - a simple deb, rpm and apk packager written in Go
Go to file
Carlos Alexandro Becker 0743b6d7a4
fix: add back bindir
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
2020-05-29 09:37:05 -03:00
.github docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
acceptance
cmd/nfpm feat: allow to specify the packager (#143) 2020-05-24 18:53:05 -03:00
deb refactor: add a method on Info to list files to copy to the package (#136) 2020-05-14 12:46:46 +00:00
glob
internal/helpers
rpm docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
testdata
www docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
.gitignore docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
.golangci.yml
.goreleaser.yml fix(ci): windows build 2020-05-26 00:47:25 -03:00
.kodiak.toml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
go.mod chore(deps): bump github.com/golangci/golangci-lint from 1.26.0 to 1.27.0 (#139) 2020-05-14 12:35:45 +00:00
go.sum fix: go mod tidy (#140) 2020-05-14 12:53:30 +00:00
LICENSE.md
Makefile docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
nfpm_test.go docs: added docs website (#142) 2020-05-24 16:09:47 -03:00
nfpm.go fix: add back bindir 2020-05-29 09:37:05 -03:00
README.md docs: badges 2020-05-14 10:10:25 -03:00
tools.go

GoReleaser Logo

NFPM

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

Release Software License GitHub Actions Codecov branch Go Report Card Go Doc Powered By: GoReleaser

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
    • 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:

nfpm init

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

nfpm pkg

And that's it!

Usage as a docker image

You can run it with docker as well:

docker run --rm \
  -v $PWD:/tmp/pkg \
  goreleaser/nfpm pkg --config /tmp/pkg/foo.yml --target /tmp/pkg/foo.rpm

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 pipe 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

goreleaser/nfpm stargazers over time


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