schema.json

{
		"$schema": "http://json-schema.org/draft/2020-12/schema",
		"$id": "https://github.com/goreleaser/nfpm/v2/config",
		"$ref": "#/$defs/Config",
		"$defs": {
			"APK": {
				"properties": {
					"arch": {
						"type": "string",
						"title": "architecture in apk nomenclature"
					},
					"signature": {
						"$ref": "#/$defs/APKSignature",
						"title": "apk signature"
					},
					"scripts": {
						"$ref": "#/$defs/APKScripts",
						"title": "apk scripts"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"APKScripts": {
				"properties": {
					"preupgrade": {
						"type": "string",
						"title": "pre upgrade script"
					},
					"postupgrade": {
						"type": "string",
						"title": "post upgrade script"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"APKSignature": {
				"properties": {
					"key_file": {
						"type": "string",
						"title": "key file",
						"examples": [
							"key.gpg"
						]
					},
					"key_id": {
						"type": "string",
						"title": "key id",
						"examples": [
							"bc8acdd415bd80b3"
						]
					},
					"key_name": {
						"type": "string",
						"title": "key name",
						"default": "maintainer_email.rsa.pub",
						"examples": [
							"origin"
						]
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"Config": {
				"properties": {
					"replaces": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "replaces directive"
					},
					"provides": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "provides directive"
					},
					"depends": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "depends directive"
					},
					"recommends": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "recommends directive"
					},
					"suggests": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "suggests directive"
					},
					"conflicts": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "conflicts directive"
					},
					"contents": {
						"items": {
							"$ref": "#/$defs/Content"
						},
						"type": "array",
						"title": "files to add to the package"
					},
					"scripts": {
						"$ref": "#/$defs/Scripts",
						"title": "scripts to execute"
					},
					"rpm": {
						"$ref": "#/$defs/RPM",
						"title": "rpm-specific settings"
					},
					"deb": {
						"$ref": "#/$defs/Deb",
						"title": "deb-specific settings"
					},
					"apk": {
						"$ref": "#/$defs/APK",
						"title": "apk-specific settings"
					},
					"name": {
						"type": "string",
						"title": "package name"
					},
					"arch": {
						"type": "string",
						"title": "target architecture",
						"examples": [
							"amd64"
						]
					},
					"platform": {
						"type": "string",
						"title": "target platform",
						"default": "linux",
						"examples": [
							"linux"
						]
					},
					"epoch": {
						"type": "string",
						"title": "version epoch",
						"default": "extracted from version",
						"examples": [
							"2"
						]
					},
					"version": {
						"type": "string",
						"title": "version",
						"examples": [
							"v1.0.2",
							"2.0.1"
						]
					},
					"version_schema": {
						"type": "string",
						"enum": [
							"semver",
							"none"
						],
						"title": "version schema",
						"default": "semver"
					},
					"release": {
						"type": "string",
						"title": "version release",
						"examples": [
							"1"
						]
					},
					"prerelease": {
						"type": "string",
						"title": "version prerelease",
						"default": "extracted from version"
					},
					"version_metadata": {
						"type": "string",
						"title": "version metadata",
						"examples": [
							"git"
						]
					},
					"section": {
						"type": "string",
						"title": "package section",
						"examples": [
							"default"
						]
					},
					"priority": {
						"type": "string",
						"title": "package priority",
						"examples": [
							"extra"
						]
					},
					"maintainer": {
						"type": "string",
						"title": "package maintainer",
						"examples": [
							"me@example.com"
						]
					},
					"description": {
						"type": "string",
						"title": "package description"
					},
					"vendor": {
						"type": "string",
						"title": "package vendor",
						"examples": [
							"MyCorp"
						]
					},
					"homepage": {
						"type": "string",
						"title": "package homepage",
						"examples": [
							"https://example.com"
						]
					},
					"license": {
						"type": "string",
						"title": "package license",
						"examples": [
							"MIT"
						]
					},
					"changelog": {
						"type": "string",
						"title": "package changelog",
						"description": "see https://github.com/goreleaser/chglog for more details",
						"examples": [
							"changelog.yaml"
						]
					},
					"disable_globbing": {
						"type": "boolean",
						"title": "wether to disable file globbing",
						"default": false
					},
					"overrides": {
						"patternProperties": {
							".*": {
								"$ref": "#/$defs/Overridables"
							}
						},
						"type": "object",
						"title": "overrides",
						"description": "override some fields when packaging with a specific packager"
					}
				},
				"additionalProperties": false,
				"type": "object",
				"required": [
					"name",
					"arch",
					"version"
				]
			},
			"Content": {
				"properties": {
					"src": {
						"type": "string"
					},
					"dst": {
						"type": "string"
					},
					"type": {
						"type": "string"
					},
					"packager": {
						"type": "string"
					},
					"file_info": {
						"$ref": "#/$defs/ContentFileInfo"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"ContentFileInfo": {
				"properties": {
					"owner": {
						"type": "string"
					},
					"group": {
						"type": "string"
					},
					"mode": {
						"type": "integer"
					},
					"mtime": {
						"type": "string",
						"format": "date-time"
					}
				},
				"additionalProperties": false,
				"type": "object",
				"required": [
					"group"
				]
			},
			"Deb": {
				"properties": {
					"arch": {
						"type": "string",
						"title": "architecture in deb nomenclature"
					},
					"scripts": {
						"$ref": "#/$defs/DebScripts",
						"title": "scripts"
					},
					"triggers": {
						"$ref": "#/$defs/DebTriggers",
						"title": "triggers"
					},
					"breaks": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "breaks"
					},
					"signature": {
						"$ref": "#/$defs/DebSignature",
						"title": "signature"
					},
					"compression": {
						"type": "string",
						"enum": [
							"gzip",
							"xz",
							"none"
						],
						"title": "compression algorithm to be used",
						"default": "gzip"
					},
					"fields": {
						"patternProperties": {
							".*": {
								"type": "string"
							}
						},
						"type": "object",
						"title": "fields"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"DebScripts": {
				"properties": {
					"rules": {
						"type": "string",
						"title": "rules"
					},
					"templates": {
						"type": "string",
						"title": "templates"
					},
					"config": {
						"type": "string",
						"title": "config"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"DebSignature": {
				"properties": {
					"key_file": {
						"type": "string",
						"title": "key file",
						"examples": [
							"key.gpg"
						]
					},
					"key_id": {
						"type": "string",
						"title": "key id",
						"examples": [
							"bc8acdd415bd80b3"
						]
					},
					"method": {
						"type": "string",
						"enum": [
							"debsign",
							"dpkg-sig"
						],
						"title": "method role",
						"default": "debsign"
					},
					"type": {
						"type": "string",
						"enum": [
							"origin",
							"maint",
							"archive"
						],
						"title": "signer role",
						"default": "origin"
					},
					"signer": {
						"type": "string",
						"title": "signer"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"DebTriggers": {
				"properties": {
					"interest": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "interest"
					},
					"interest_await": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "interest await"
					},
					"interest_noawait": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "interest noawait"
					},
					"activate": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "activate"
					},
					"activate_await": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "activate await"
					},
					"activate_noawait": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "activate noawait"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"Overridables": {
				"properties": {
					"replaces": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "replaces directive"
					},
					"provides": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "provides directive"
					},
					"depends": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "depends directive"
					},
					"recommends": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "recommends directive"
					},
					"suggests": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "suggests directive"
					},
					"conflicts": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"title": "conflicts directive"
					},
					"contents": {
						"items": {
							"$ref": "#/$defs/Content"
						},
						"type": "array",
						"title": "files to add to the package"
					},
					"scripts": {
						"$ref": "#/$defs/Scripts",
						"title": "scripts to execute"
					},
					"rpm": {
						"$ref": "#/$defs/RPM",
						"title": "rpm-specific settings"
					},
					"deb": {
						"$ref": "#/$defs/Deb",
						"title": "deb-specific settings"
					},
					"apk": {
						"$ref": "#/$defs/APK",
						"title": "apk-specific settings"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"RPM": {
				"properties": {
					"arch": {
						"type": "string",
						"title": "architecture in rpm nomenclature"
					},
					"scripts": {
						"$ref": "#/$defs/RPMScripts",
						"title": "rpm-specific scripts"
					},
					"group": {
						"type": "string",
						"title": "package group",
						"examples": [
							"Unspecified"
						]
					},
					"summary": {
						"type": "string",
						"title": "package summary"
					},
					"compression": {
						"type": "string",
						"enum": [
							"gzip",
							"lzma",
							"xz"
						],
						"title": "compression algorithm to be used",
						"default": "gzip:-1"
					},
					"signature": {
						"$ref": "#/$defs/RPMSignature",
						"title": "rpm signature"
					},
					"packager": {
						"type": "string",
						"title": "organization that actually packaged the software"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"RPMScripts": {
				"properties": {
					"pretrans": {
						"type": "string",
						"title": "pretrans script"
					},
					"posttrans": {
						"type": "string",
						"title": "posttrans script"
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"RPMSignature": {
				"properties": {
					"key_file": {
						"type": "string",
						"title": "key file",
						"examples": [
							"key.gpg"
						]
					},
					"key_id": {
						"type": "string",
						"title": "key id",
						"examples": [
							"bc8acdd415bd80b3"
						]
					}
				},
				"additionalProperties": false,
				"type": "object"
			},
			"Scripts": {
				"properties": {
					"preinstall": {
						"type": "string",
						"title": "pre install"
					},
					"postinstall": {
						"type": "string",
						"title": "post install"
					},
					"preremove": {
						"type": "string",
						"title": "pre remove"
					},
					"postremove": {
						"type": "string",
						"title": "post remove"
					}
				},
				"additionalProperties": false,
				"type": "object"
			}
		},
		"description": "nFPM configuration definition file"
	}