nFPM

nFPM configuration file

Type Config
File match nfpm.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/nfpm/latest.json
Source https://nfpm.goreleaser.com/static/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: Config

nFPM configuration definition file

Definitions

APK object
arch string
signature object
3 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
key_name string
Default: "maintainer_email.rsa.pub"
Examples: "origin"
scripts object
2 nested properties
preupgrade string
postupgrade string
APKScripts object
preupgrade string
postupgrade string
APKSignature object
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
key_name string
Default: "maintainer_email.rsa.pub"
Examples: "origin"
ArchLinux object
pkgbase string
arch string
packager string
scripts object
2 nested properties
preupgrade string
postupgrade string
ArchLinuxScripts object
preupgrade string
postupgrade string
Config object
name string required
arch string required
Examples: "amd64"
version string required
Examples: "v1.0.2", "2.0.1"
replaces string[]
provides string[]
depends string[]
recommends string[]
suggests string[]
conflicts string[]
contents Content[]
umask integer
Examples: 112
scripts object
4 nested properties
preinstall string
postinstall string
preremove string
postremove string
rpm object
9 nested properties
arch string
buildhost string
scripts object
3 nested properties
pretrans string
posttrans string
verify string
group string
Examples: "Unspecified"
summary string
compression string
Default: "gzip:-1"
Values: "gzip" "lzma" "xz" "zstd"
signature object
2 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
packager string
prefixes string[]
deb object
9 nested properties
arch string
arch_variant string
Examples: "amd64v3"
scripts object
3 nested properties
rules string
templates string
config string
triggers object
6 nested properties
interest string[]
interest_await string[]
interest_noawait string[]
activate string[]
activate_await string[]
activate_noawait string[]
breaks string[]
signature object
5 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
method string
Default: "debsign"
Values: "dpkg-sig" "debsign"
type string
Default: "origin"
Values: "origin" "maint" "archive"
signer string
compression string
Default: "gzip:-1"
Values: "gzip" "xz" "zstd" "none"
fields Record<string, string>
predepends string[]
apk object
3 nested properties
arch string
signature object
3 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
key_name string
Default: "maintainer_email.rsa.pub"
Examples: "origin"
scripts object
2 nested properties
preupgrade string
postupgrade string
archlinux object
4 nested properties
pkgbase string
arch string
packager string
scripts object
2 nested properties
preupgrade string
postupgrade string
ipk object
8 nested properties
abi_version string
alternatives IPKAlternative[]
arch string
auto_installed boolean
Default: false
essential boolean
Default: false
fields Record<string, string>
predepends string[]
tags string[]
msix object
8 nested properties
publisher string required
Examples: "CN=MyCompany, O=MyCompany, C=US"
applications MSIXApplication[] required
arch string
identity object
1 nested properties
resource_id string
properties object
3 nested properties
display_name string
publisher_display_name string
logo string
dependencies object
1 nested properties
target_device_families MSIXTargetDeviceFamily[]
capabilities object
3 nested properties
capabilities string[]
device_capabilities string[]
restricted string[]
signature object
1 nested properties
pfx_file string
platform string
Default: "linux"
Examples: "linux"
epoch string
Default: "extracted from version"
Examples: "2"
version_schema string
Default: "semver"
Values: "semver" "none"
release string
Examples: "1"
prerelease string
Default: "extracted from version"
version_metadata string
Examples: "git"
section string
Examples: "default"
priority string
Examples: "extra"
maintainer string
Examples: "[email protected]"
description string
vendor string
Examples: "MyCorp"
homepage string
Examples: "https://example.com"
license string
Examples: "MIT"
changelog string

see https://github.com/goreleaser/chglog for more details

Examples: "changelog.yaml"
disable_globbing boolean
Default: false
mtime string
format=date-time
overrides Record<string, object>

override some fields when packaging with a specific packager

Content object
dst string required
src string
type string
Default: ""
Values: "symlink" "ghost" "config" "config|noreplace" "dir" "tree" ""
packager string
file_info object
4 nested properties
owner string
group string
mode integer
mtime string
format=date-time
expand boolean
ContentFileInfo object
owner string
group string
mode integer
mtime string
format=date-time
Contents Content[]
Deb object
arch string
arch_variant string
Examples: "amd64v3"
scripts object
3 nested properties
rules string
templates string
config string
triggers object
6 nested properties
interest string[]
interest_await string[]
interest_noawait string[]
activate string[]
activate_await string[]
activate_noawait string[]
breaks string[]
signature object
5 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
method string
Default: "debsign"
Values: "dpkg-sig" "debsign"
type string
Default: "origin"
Values: "origin" "maint" "archive"
signer string
compression string
Default: "gzip:-1"
Values: "gzip" "xz" "zstd" "none"
fields Record<string, string>
predepends string[]
DebScripts object
rules string
templates string
config string
DebSignature object
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
method string
Default: "debsign"
Values: "dpkg-sig" "debsign"
type string
Default: "origin"
Values: "origin" "maint" "archive"
signer string
DebTriggers object
interest string[]
interest_await string[]
interest_noawait string[]
activate string[]
activate_await string[]
activate_noawait string[]
IPK object
abi_version string
alternatives IPKAlternative[]
arch string
auto_installed boolean
Default: false
essential boolean
Default: false
fields Record<string, string>
predepends string[]
tags string[]
IPKAlternative object
priority integer
target string
link_name string
MSIX object
publisher string required
Examples: "CN=MyCompany, O=MyCompany, C=US"
applications MSIXApplication[] required
arch string
identity object
1 nested properties
resource_id string
properties object
3 nested properties
display_name string
publisher_display_name string
logo string
dependencies object
1 nested properties
target_device_families MSIXTargetDeviceFamily[]
capabilities object
3 nested properties
capabilities string[]
device_capabilities string[]
restricted string[]
signature object
1 nested properties
pfx_file string
MSIXApplication object
id string required
executable string required
entry_point string
Default: "Windows.FullTrustApplication"
visual_elements object
5 nested properties
display_name string
description string
background_color string
Default: "transparent"
square150x150_logo string
square44x44_logo string
MSIXCapabilities object
capabilities string[]
device_capabilities string[]
restricted string[]
MSIXDependencies object
target_device_families MSIXTargetDeviceFamily[]
MSIXIdentity object
resource_id string
MSIXProperties object
display_name string
publisher_display_name string
logo string
MSIXSignature object
pfx_file string
MSIXTargetDeviceFamily object
name string required
Examples: "Windows.Desktop"
min_version string required
Examples: "10.0.17763.0"
max_version_tested string required
Examples: "10.0.22621.0"
MSIXVisualElements object
display_name string
description string
background_color string
Default: "transparent"
square150x150_logo string
square44x44_logo string
Overridables object
replaces string[]
provides string[]
depends string[]
recommends string[]
suggests string[]
conflicts string[]
contents Content[]
umask integer
Examples: 112
scripts object
4 nested properties
preinstall string
postinstall string
preremove string
postremove string
rpm object
9 nested properties
arch string
buildhost string
scripts object
3 nested properties
pretrans string
posttrans string
verify string
group string
Examples: "Unspecified"
summary string
compression string
Default: "gzip:-1"
Values: "gzip" "lzma" "xz" "zstd"
signature object
2 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
packager string
prefixes string[]
deb object
9 nested properties
arch string
arch_variant string
Examples: "amd64v3"
scripts object
3 nested properties
rules string
templates string
config string
triggers object
6 nested properties
interest string[]
interest_await string[]
interest_noawait string[]
activate string[]
activate_await string[]
activate_noawait string[]
breaks string[]
signature object
5 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
method string
Default: "debsign"
Values: "dpkg-sig" "debsign"
type string
Default: "origin"
Values: "origin" "maint" "archive"
signer string
compression string
Default: "gzip:-1"
Values: "gzip" "xz" "zstd" "none"
fields Record<string, string>
predepends string[]
apk object
3 nested properties
arch string
signature object
3 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
key_name string
Default: "maintainer_email.rsa.pub"
Examples: "origin"
scripts object
2 nested properties
preupgrade string
postupgrade string
archlinux object
4 nested properties
pkgbase string
arch string
packager string
scripts object
2 nested properties
preupgrade string
postupgrade string
ipk object
8 nested properties
abi_version string
alternatives IPKAlternative[]
arch string
auto_installed boolean
Default: false
essential boolean
Default: false
fields Record<string, string>
predepends string[]
tags string[]
msix object
8 nested properties
publisher string required
Examples: "CN=MyCompany, O=MyCompany, C=US"
applications MSIXApplication[] required
arch string
identity object
1 nested properties
resource_id string
properties object
3 nested properties
display_name string
publisher_display_name string
logo string
dependencies object
1 nested properties
target_device_families MSIXTargetDeviceFamily[]
capabilities object
3 nested properties
capabilities string[]
device_capabilities string[]
restricted string[]
signature object
1 nested properties
pfx_file string
RPM object
arch string
buildhost string
scripts object
3 nested properties
pretrans string
posttrans string
verify string
group string
Examples: "Unspecified"
summary string
compression string
Default: "gzip:-1"
Values: "gzip" "lzma" "xz" "zstd"
signature object
2 nested properties
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
packager string
prefixes string[]
RPMScripts object
pretrans string
posttrans string
verify string
RPMSignature object
key_file string
Examples: "key.gpg"
key_id string
Examples: "bc8acdd415bd80b3"
Scripts object
preinstall string
postinstall string
preremove string
postremove string