1
1
Fork 0
mirror of https://github.com/goreleaser/nfpm synced 2024-05-27 17:16:12 +02:00
NFPM is Not FPM - a simple deb, rpm and apk packager written in Go
Go to file
Carlos Alexandro Becker fd58e75308
docs: readme
2018-06-15 16:35:26 -03:00
.github docs: issue template 2018-04-12 09:49:09 -03:00
acceptance test: fix duplicated code and other issues 2018-06-04 09:08:27 -03:00
cmd/nfpm docs: Add overrides section to example config 2018-06-04 08:46:18 -03:00
deb test: fix duplicated code and other issues 2018-06-04 09:08:27 -03:00
glob chore: improving error handling and wrapping 2018-03-27 20:36:02 -03:00
rpm test: fix duplicated code and other issues 2018-06-04 09:08:27 -03:00
testdata refactor: overrides using explicit embedded struct 2018-04-10 17:39:43 +02:00
.gitignore chore: using golangci-lint as linter 2018-06-02 15:22:21 -03:00
.goreleaser.yml feat: added docker image 2018-06-15 16:33:52 -03:00
.travis.yml test: starting to add acceptance tests 2018-03-11 14:58:53 -03:00
CODE_OF_CONDUCT.md docs: readme, coc, contributing 2018-02-18 19:32:16 -03:00
CONTRIBUTING.md docs: readme, coc, contributing 2018-02-18 19:32:16 -03:00
Dockerfile feat: added docker image 2018-06-15 16:33:52 -03:00
Gopkg.lock chore: removed yaml.v1 2018-04-18 22:25:48 -03:00
Gopkg.toml chore: removed yaml.v1 2018-04-18 22:25:48 -03:00
LICENSE.md Create LICENSE.md 2018-02-03 17:11:21 -02:00
Makefile fix: test timeout 2018-06-04 08:48:41 -03:00
README.md docs: readme 2018-06-15 16:35:26 -03:00
nfpm.go feat: support creating empty managed dirs 2018-05-16 21:42:34 -03:00
nfpm_test.go feat: validate overrides for known formats 2018-04-10 21:37:46 +02:00

GoReleaser Logo

NFPM

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

Release Software License Travis Codecov branch Go Report Card Go Doc SayThanks.io 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 (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:

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

goreleaser/nfpm stargazers over time


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