mirror of
https://github.com/goreleaser/nfpm
synced 2024-05-28 18:16:30 +02:00
92 lines
3.9 KiB
Markdown
92 lines
3.9 KiB
Markdown
<p align="center">
|
|
<img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" />
|
|
<h3 align="center">NFPM</h3>
|
|
<p align="center">NFPM is Not FPM - a simple deb and rpm packager written in Go.</p>
|
|
<p align="center">
|
|
<a href="https://github.com/goreleaser/nfpm/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/goreleaser/nfpm.svg?style=for-the-badge"></a>
|
|
<a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge"></a>
|
|
<a href="https://github.com/goreleaser/goreleaser/actions?workflow=build"><img alt="GitHub Actions" src="https://img.shields.io/github/workflow/status/goreleaser/goreleaser/build?style=for-the-badge"></a>
|
|
<a href="https://codecov.io/gh/goreleaser/nfpm"><img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/goreleaser/nfpm/master.svg?style=for-the-badge"></a>
|
|
<a href="https://goreportcard.com/report/github.com/goreleaser/nfpm"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/goreleaser/nfpm?style=for-the-badge"></a>
|
|
<a href="http://godoc.org/github.com/goreleaser/nfpm"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge"></a>
|
|
<a href="https://github.com/goreleaser"><img alt="Powered By: GoReleaser" src="https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=for-the-badge"></a>
|
|
</p>
|
|
</p>
|
|
|
|
## 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
|
|
|
|
* [x] be simple to use
|
|
* [x] provide packaging for the most common linux packaging systems (at very least deb and rpm)
|
|
* [x] be distributed as a single binary
|
|
* [x] reproducible results
|
|
* [x] depend on the fewer external things as possible
|
|
* [x] generate packages based on yaml files (maybe also json and toml?)
|
|
* [x] 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 a docker image
|
|
|
|
You can run it with docker as well:
|
|
|
|
```sh
|
|
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](https://github.com/goreleaser/goreleaser/blob/master/internal/pipe/nfpm/nfpm.go).
|
|
|
|
> **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](https://opencollective.com/goreleaser)! It's
|
|
easy and will surely help the developers at least buy some ☕️ or 🍺!
|
|
|
|
## Stargazers over time
|
|
|
|
[](https://starcharts.herokuapp.com/goreleaser/nfpm)
|
|
|
|
---
|
|
|
|
Would you like to fix something in the documentation? Feel free to open an [issue](https://github.com/goreleaser/nfpm/issues).
|
|
|
|
[goreleaser]: https://goreleaser.com/#linux_packages.nfpm
|
|
[fpm]: https://github.com/jordansissel/fpm
|