electron-builder.json

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template).

description: The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).

description: As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.

description: The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).

description: The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). Only plain text is supported.

description: The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.

$ref: #/definitions/GithubOptions

$ref: #/definitions/SpacesOptions

$ref: #/definitions/GenericServerOptions

$ref: #/definitions/BintrayOptions

$ref: #/definitions/CustomPublishOptions

description: The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).

default: ask

description: The system integration installation.

enum: ask doNotAsk

title: AppImageOptions

description: Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.

description: The application id. Defaults to `identityName`. Can't start with numbers.

description: The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).

description:
A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
Defaults to the application product name.

description: The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).

description:
The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.
The first entry (index 0) will be the default language.
Defaults to en-US if omitted.

description: The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.

description:
A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
Defaults to company name from the application metadata.

description: Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.

description: Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875

title: AppXOptions

description: Allows external asar files.

description: Whether to automatically unpack executables files.

title: AsarOptions

description:
[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page ("Edit Your Profile" -> API Key).
Define `BT_TOKEN` environment variable.

description: The Bintray component (Debian only).

default: stable

description: The Bintray distribution (Debian only).

description: The owner.

description: The Bintray package name.

description: The provider. Must be `bintray`.

description:
Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

default: generic

description: The Bintray repository name.

description: The Bintray user account. Used in cases where the owner is an organization.

title: BintrayOptions

$ref: #/definitions/PublishProvider

description: The provider.

title: CustomPublishOptions

enum: bzip2 gz xz

default: xz

description: The compression type.

description: Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]`.

description:
*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.

Example: `["--before-install=build/deb-preinstall.sh", "--after-upgrade=build/deb-postinstall.sh"]`

description: The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section).

description: The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute.

title: DebOptions

description: The name of the file within the DMG. Defaults to basename of `path`.

description: The path of the file within the DMG.

enum: dir file link

required: x y

title: DmgContent

description:
The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.
If background is not specified, use `window.size`. Default locations expected background size to be 540x380.

description: The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.

description: The content — to customize icon locations.

$ref: #/definitions/DmgContent

default: UDZO

description: The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).

enum: UDBZ UDCO UDRO UDRW UDZO ULFO

description:
The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to the application icon (`build/icon.icns`).

description: The size of all the icons inside the DMG.

description: The size of all the icon texts inside the DMG.

description: Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).

description:
The title of the produced DMG, which will be shown when mounted (volume name).

Macro `${productName}`, `${version}` and `${name}` are supported.

description: The DMG windows position and size.

title: DmgOptions

description: The height. Defaults to background image height or 380.

description: The width. Defaults to background image width or 540.

description: The X position relative to left of the screen.

description: The Y position relative to top of the screen.

title: DmgWindow

description: The [cache location](https://github.com/electron-userland/electron-download#cache-location).

description: The mirror.

title: ElectronDownloadOptions

description:
File associations.

macOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.

On Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.

description: *windows-only.* The description.

description: The extension (minus the leading period). e.g. `png`.

description:
The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.

Not supported on Linux, file issue if need (default icon will be `x-office-document`).

description: *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.

description: *linux-only.* The mime-type.

description: The name. e.g. `PNG`. Defaults to `ext`.

description: *macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.

title: FileAssociation

description: The [glob patterns](/file-patterns).

description: The source path relative to the project directory.

description: The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.

title: FileSet

description:
Generic (any HTTP(S) server) options.
In all publish options [File Macros](/file-patterns#file-macros) are supported.

description: The channel.

description: The provider. Must be `generic`.

description: The base url. e.g. `https://bucket_name.s3.amazonaws.com`.

description: Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.

title: GenericServerOptions

description:
[GitHub](https://help.github.com/articles/about-releases/) options.

GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.
Define `GH_TOKEN` environment variable.

description: The host (including the port if need).

description: The owner.

description: Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).

description: The protocol. GitHub Publisher supports only `https`.

description: The provider. Must be `github`.

description:
The type of release. By default `draft` release will be created.

Also you can set release type using environment variable. If `EP_DRAFT`is set to `true` — `draft`, if `EP_PRE_RELEASE`is set to `true` — `prerelease`.

description: The repository name. [Detected automatically](#github-repository-and-bintray-package).

description: The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).

description: Whether to use `v`-prefixed tag name.

title: GithubOptions

description:
The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).

description:
Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).

Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.

description: A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.

description: The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.

description: Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.

description: The [electron-updater compatibility](/auto-update#compatibility) semver range.

description:
The executable name. Defaults to `productName`.
Cannot be specified per target, allowed only in the `linux`.

description: The file associations.

description: Whether to fail if app will be not code signed.

description: Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).

description:
The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.
By default will be generated automatically based on the macOS icns file.

description: The maintainer. Defaults to [author](/configuration/configuration#Metadata-author).

description: backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place

description: The URL protocol schemes.

description:
The release info. Intended for command line usage:

```
-c.releaseInfo.releaseNotes="new features"
```

description:
Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.

electron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform.

Please [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz.

description: The vendor. Defaults to [author](/configuration/configuration#Metadata-author).

title: LinuxConfiguration

description: The compression type.

description: Package dependencies.

description: The package category.

title: LinuxTargetSpecificOptions

description: Paths of any extra binaries that need to be signed.

description: The `CFBundleShortVersionString`. Do not use it unless you need to.

description: The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).

description:
The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.

For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*.

Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).

description: Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.

description: Whether your app has to be signed with hardened runtime.

description: Whether to let electron-osx-sign validate the signing or not.

description: The electron locales. By default Electron locales used as is.

description:
The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).
MAS entitlements is specified in the [mas](/configuration/mas).

description:
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).

This option only applies when signing with `entitlements` provided.

description: The extra entries for `Info.plist`.

description: Extra files to put in archive. Not applicable for `tar.*`.

description: The file associations.

description: The bundle identifier to use in the application helper's plist.

description: The path to application icon.

description:
The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.
MAS installer identity is specified in the [mas](/configuration/mas).

description: The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.

description: The URL protocol schemes.

description: The path to the provisioning profile to use when signing, absolute or relative to the app root.

description: Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.

description: The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).

description: Whether to sign app for development or for distribution.

title: MacConfiguration

description:
The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).

description:
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).

description: The extra entries for `Info.plist`.

description: The file associations.

description: The path to application icon.

description: The URL protocol schemes.

title: MasConfiguration

description: The application directory (containing the application package.json), defaults to `app`, `www` or working directory.

description:
The path to build resources.

Please note — build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `"files": ["**\/*", "build/icon.*"]`

description: The output directory. [File macros](/file-patterns#file-macros) are supported.

title: MetadataDirectories

description: Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).

description: Whether to create start menu shortcut.

description: Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.

description: One-click installation.

description: Whether to install per all users (per-machine).

description: Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.

description: The name that will be used for all shortcuts. Defaults to the application name.

description: The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.

description: If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.

title: MsiOptions

description: *assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.

description: *assisted installer only.* Whether to allow user to change installation directory.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.

description: Whether to create start menu shortcut.

description: *one-click installer only.* Whether to delete app data on uninstall.

description: Defaults to `true` for web installer (`nsis-web`)

description: Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).

description: See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).

description: The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).

description: *assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.

description:
*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerHeaderIcon.ico` or application icon.

description:
The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerIcon.ico` or application icon.

description: The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what.

description:
*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`. Image size 164 × 314 pixels.

description: [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).

description:
The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).

Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.
If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).

Appropriate license file will be selected by user OS language.

description: Whether to create multi-language installer. Defaults to `unicode` option value.

description: Whether to create one-click installer or assisted.

description: Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.

description:
Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).

If `oneClick` is `true` (default): Whether to install per all users (per-machine).

If `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.

If `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.

default: .avi .mov .m4v .mp4 .m4p .qt .mkv .webm .vmdk

description: The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files.

description: The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).

description: Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).

description: The uninstaller display name in the control panel.

description:
The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/uninstallerIcon.ico` or application icon.

description:
*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`

description: If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.

title: NsisOptions

description: Web Installer options.

description:
The application package download URL. Optional — by default computed using publish configuration.

URL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).
Please note — it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).

Custom `X-Arch` http header is set to `32` or `64`.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`.

description: Whether to create start menu shortcut.

title: NsisWebOptions

description: Options for the background image in a PKG installer

enum: bottom bottomleft bottomright center left right top topleft topright

description:
Alignment of the background image.
Options are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright

description: Path to the image to use as an installer background.

description:
Scaling of the background image.
Options are: tofit, none, proportional

title: PkgBackgroundOptions

description: macOS product archive options.

description:
Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.

Corresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description:
Whether can be installed into the current user's home directory.
A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.
If the product cannot be installed in the user's home directory and be not completely functional from user's home directory.

Corresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description:
Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.

Corresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description: Options for the background image for the installer.

description: The path to the conclusion file. This may be used to customize the text on the final "Summary" page of the installer.

description: Require identical bundle identifiers at install path?

description: The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.

description:
The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.
Mostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.

description: Install bundle over previous version if moved by user?

description: Don't install bundle if newer version on disk?

description:
Specifies how an existing version of the bundle on disk should be handled when the version in
the package is installed.

If you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;
this has the effect of deleting old paths that no longer exist in the new version of
the bundle.

If you specify update, the bundle in the package overwrites the version on disk, and any files
not contained in the package will be left intact; this is appropriate when you are delivering
an update-only package.

Another effect of update is that the package bundle will not be installed at all if there is
not already a version on disk; this allows a package to deliver an update for an app that
the user might have deleted.

description: should be not documented, only to experiment

description:
The scripts directory, relative to `build` (build resources directory).
The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.
Scripts are required to be executable (`chmod +x file`).

description: The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.

title: PkgOptions

title: PlugDescriptor

description: Portable options.

description: The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows.

description:
The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.

Defaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).

title: PortableOptions

description:
URL Protocol Schemes. Protocols to associate the app with. macOS only.

Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).

description: The name. e.g. `IRC server URL`.

description: *macOS-only* The app's role with respect to the type.

description: The schemes. e.g. `["irc", "ircs"]`.

title: Protocol

title: PublishProvider

description: The release date.

description: The release name.

description: The release notes.

description: The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).

title: ReleaseInfo

description:
The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

Please see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128).

description: The bucket name.

description: The update channel.

description: Server-side encryption algorithm to use for the object.

description:
The endpoint URI to send requests to. The default endpoint is built from the configured region.
The endpoint should be a string like `https://{service}.{region}.amazonaws.com`.

description: The directory path.

description: The provider. Must be `s3`.

description: The region. Is determined and set automatically when publishing.

description: The type of storage to use for the object.

title: S3Options

description:
Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.
Defaults to `["desktop-gtk2""]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults.

description: The list of features that must be supported by the core in order for this snap to install.

description: The list of debian packages needs to be installed for building this snap.

description: The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.

description: The custom environment. Defaults to `{"TMPDIR: "$XDG_RUNTIME_DIR"}`. If you set custom, it will be merged with default.

description: The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the "stable" or "candidate" channels) or "stable" (i.e. a stable release or release candidate, which can be released to all channels).

description: The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).

description:
The list of [plugs](https://snapcraft.io/docs/reference/interfaces).
Defaults to `["desktop", "desktop-legacy", "home", "x11", "unity7", "browser-support", "network", "gsettings", "pulseaudio", "opengl"]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom plug `foo` in addition to defaults.

Additional attributes can be specified using object instead of just name of plug:
```
[
  {
    "browser-sandbox": {
      "interface": "browser-support",
      "allow-sandbox": true
    },
  },
  "another-simple-plug-name"
]
```

description:
The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.
Defaults to `["libasound2", "libgconf2-4", "libnotify4", "libnspr4", "libnss3", "libpcre3", "libpulse0", "libxss1", "libxtst6"]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom package `foo` in addition to defaults.

description: The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).

description: Whether to use template snap. Defaults to `true` if `stagePackages` not specified.

title: SnapOptions

description:
[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.
Access key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.

description: The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

description: The update channel.

description: The space name.

description: The directory path.

description: The provider. Must be `spaces`.

description: The region (e.g. `nyc3`).

title: SpacesOptions

description:
A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.

Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.

If you don't plan to build windows installer, you can omit it.
If your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.

description:
The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)
(otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).

description: Whether to create an MSI installer. Defaults to `false` (MSI is not created).

description: A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.

description: Authentication token for remote updates

description: Use `appId` to identify package instead of `name`.

title: SquirrelWindowsOptions

description: The arch or list of archs.

description: The target name. e.g. `snap`.

title: TargetConfiguration

description: The path to an additional certificate file you want to add to the signature block.

description:
The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.
Please see [Code Signing](/code-signing).

description:
The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.
Please see [Code Signing](/code-signing).

description: The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

description: The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

description: The file associations.

description: The path to application icon.

description: The trademarks and registered trademarks.

description: The URL protocol schemes.

description:
[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.
Defaults to common name from your code signing certificate.

description:
The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed.
Cannot be specified per target, allowed only in the `win`.

description: The URL of the RFC 3161 time stamp server.

description: The custom function (or path to file or module id) to sign Windows executable.

description: Whether to sign and add metadata to executable. Advanced option.

description: Whether to sign DLL files. Advanced option.

description: Array of signing algorithms used. For AppX `sha256` is always used.

description:
The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.
AppX package can be built only on Windows 10.

To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.

description: The URL of the time stamp server.

description:
Whether to verify the signature of an available update before installation.
The [publisher name](#publisherName) will be used for the signature verification.

title: WindowsConfiguration

description: Configuration Options

description: JSON Schema for this document.

description: The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).

description: The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).

description: The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).

description: AppImage options.

description: The function (or path to file or module id) to be run on artifact build completed.

description: The function (or path to file or module id) to be run on artifact build start.

description:
The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.

If provided and `node_modules` are missing, it will not invoke production dependencies check.

description: Whether to build the application native dependencies from source.

description:
The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.
If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).

description: The human-readable copyright line for the app.

description: Debian package options.

description: macOS DMG options.

description: Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.

description: The path to custom Electron build (e.g. `~/electron/out/R`).

description: The [electron-download](https://github.com/electron-userland/electron-download#usage) options.

description: The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.

description:
The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported.

If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.

description: Inject properties to `package.json`.

description: The file associations.

description: The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.

description: Whether to include PDB files.

description: *libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.

description: Options related to how build Linux targets.

description: Options related to how build macOS targets.

description: MAS (Mac Application Store) options.

description: The version of muon you are packaging for.

description:
Whether to execute `node-gyp rebuild` before starting to package the app.

Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.

description:
*libui-based frameworks only* The version of NodeJS you are packaging for.
You can set it to `current` to set the Node.js version that you use to run.

description: Additional command line arguments to use when installing app native deps.

description: Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.

description: The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file.

description: macOS PKG options.

description: As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).

description: The URL protocol schemes.

description: Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).

description: Whether to build using Electron Build Service if target not supported on current OS.

description: Whether to remove `scripts` field from `package.json` files.

description: Snap options.

description: Options related to how build Windows targets.


grunt-cssmin-task.json

type: object

$ref: #/definitions/options

description: Set the options for cssmin

description: Prefix the compressed source with the given banner, with a linebreak in between.

description: To keep or remove special comments, exposing the underlying option from 'clean-css'.

type: number string

description: Either report only minification result or report minification and gzip results. This is useful to see exactly how well clean-css is performing but using  'gzip'  will make the task take 5-10x longer to complete.

type: string

enum: min gzip

default: min

title: JSON schema for the Grunt cssmin task


briefcase-schema.json

title: MLBriefcase

description: A ML briefcase schema

description: The name of this resource

description: Name of the credential provider to be used.

$ref: #/definitions/property

description: Allows to attach user-definied metadata to resources

description: Overrides the key to lookup the value for the property.

description: Azure tenant id (a GUID)

description: AWS Boto3

$ref: #/definitions/resource

description: Region name

description: AWS Access Key ID

description: Azure services

description: Azure authentication services

description: Azure Device Code authentication

type: array

description: Azure Device Code authentication. Prompts the user with a URL.

$ref: #/definitions/azureTenantId

default: devicecode

description: Azure Managed Service Idenity

description: Azure Managed Service Identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview)

description: Azure Service Princiapl

description: Azure Service Principal

default: serviceprincipal

description: TODO The client id (a guid)

description: Azure Subscription

description: Azure Subscription

description: Azure subscription id (e.g. guids)

description: List of Azure subscription ids (e.g. guids)

description: Azure KeyVaults

description: Azure KeyVault https://docs.microsoft.com/en-us/azure/key-vault

default: keyvault

description: DNS for the Azure KeyVault instance

description: Name of credential resource. E.g. device code or service principal resource

description: Azure Cognitive Services

description: Azure Cognitive Service Anomaly Detection (https://docs.microsoft.com/en-us/azure/cognitive-services/anomaly-detector/)

description: End point URL for Azure Cognitive Service

description: Azure Cognitive Service Content Moderator

description: Azure Cognitive Service Face

description: Azure Cognitive Service Face (https://azure.microsoft.com/en-us/services/cognitive-services/face/)

description: Azure Cognitive Service Spell Checker

description: Azure Cognitive Service Spell Checker

description: Azure Cognitive Service Text Analytics

description: Azure Cognitive Service Text Analytics

description: Azure Cognitive Service Vision

description: Azure Cognitive Service Vision

description: Azure Storage Services

description: Azure Storage Account

description: Azure Storage Account

description: Azure blob account name

description: Azure blob account key

description: Is the secret a key or SAS token

default: key

enum: key sas

description: Azure Blob Storage

description: Azure Blob Storage

description: URL to Azure blob

description: Name of Azure Storage account resource object

description: Name of container

description: Path to blob

description: Amazon Web Services (AWS)

description: AWS Rekognition services

description: AWS Rekognition services

description: Google Cloud Platform services

description: Google NER service

description: Google video intelligence for content moderation annotation

description: Google Face Detect SDK

description: ClarifAI Services

description: Clarifai Moderation image SDK

description: Clarifai Moderation image SDK

description: Python specific resources

description: JupyterLab Credential Provider

description: Environment variable Credential Provider

description: .env file Credential Provider

description: Python KeyRing Credential Provider (https://pypi.org/project/keyring)

description: Service name used when calling get_password

description: Python SQL Alchemy (https://www.sqlalchemy.org/)

description: the name of the database backend. This name will correspond to a module in sqlalchemy/databases or a third party plug-in.

description: The user name.

description: The name of the host.

description: The port number.

description: The database name.

description: A dictionary of options to be passed to the dialect and/or the DBAPI upon connect.


grunt-jshint-task.json

description: Set the options for JSHint

description: Either a boolean value or a string containing the file name of the jshintrc file.

type: boolean string

title: JSON schema for the Grunt JSHint task


cargo-make.json

title: Semantic Version

title: External Makefile

description: A potentially optional external makefile to extend

title: File Path

description: The path of the external makefile, relative to this file

description: If true, the external makefile is optional and does not need to exist

type: boolean

title: Script

title: Script Line

title: Script Lines

title: Script File

file: path/to/script

title: File Path

description: Scipt file name

default: path/to/script

description: If true, the `file` value is an absolute path

title: Split Script

description: Script content split to parts to enable a more fine tuned extension capability

initKeys: pre main post

title: Pre-Main Script

description: Pre-main script section

title: Main Script

description: Main script section

title: Post-Main Script

description: Post-main script section

title: List of Env Files

description: Load environment files

$ref: #/definitions/envfile

title: Env File

description: File containing environment variables and their values

profile: development

title: File Path

description: The path to the env file

description: The env file path and attributes

title: File Path

description: The path to the env file

title: Directory Path

description: The path base directory (relative paths are from this base path)

default: path/to/dir

title: Profile

description: The profile name this file is relevant to

default: development

examples: development production

title: Env Vars

description: Setup environment variables

title: Env Value

description: An environment variable value

title: Boolean

title: Integer

type: integer

title: String

title: Separator List

description: An array which will be joined with the `;` separator

title: Profile Env Vars

description: Profile dependent environment variables

$ref: #/definitions/env

title: Unset

description: Unsets environment variable

description: If true, the env variable will be unset, else ignored

title: Env Value Script

description: Provide environment variable via script

title: Script Lines

description: Enable multi-line values

title: Env Value Mapping

description: Environment variable value provided by decoding other values

required: source mapping

title: Env Var

description: The source environment variable (can be an env expression)

title: Env Value

description: The default value in case no decode mapping was found, if not provided it will default to the source value

title: Value Mapping

description: The decoding mapping from one value to another value

title: Env Value

title: Conditional Env Value

description: Environment variable value set if condition is met

title: Env Value

description: The value to set (can be an env expression)

description: Condition to evaluate to see whether to set the environment value or not

title: Env Value Glob

description: Environment value holding a list of paths based on given glob definitions

title: Glob Pattern

description: The glob used to fetch all paths

description: If true, include files in glob

description: If true, include directories in glob

title: Ignore Source

description: An ignore source that enables respecting ignore files from that source

default: git

title: Condition

description: Conditions allow you to evaluate at runtime if to run a specific task or not

title: Message

description: Message to display when the condition fails

title: List of Profiles

description: Profile names to match for the condition

title: Profile

description: Profile name

title: List of Platforms

description: Platform names to match for the condition

title: Platform

description: Platform name

enum: linux windows mac

title: List of Channels

description: Rust channels to match for the condition

title: Channel

description: Rust channel

enum: stable beta nightly

title: List of Env Vars

description: List of environment variables which must be defined

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must not be defined

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must be defined and must not be set to any of the following (case insensitive): `false`, `no`, `0`, or empty

title: Env Var

description: Environment variable

title: List of Env Vars

description: List of environment variables which must be defined and must be set to any of the following (case insensitive): `false`, `no`, `0`, or empty

title: Env Var

description: Environment variable

title: Env Vars

description: Map of environment variables that must be defined and equal to the provided values

title: Env Value

description: Environment value

title: Env Vars

description: Map of environment variables that must be defined and contain (case insensitive) the provided values

title: Env Value

description: Environment value

title: Rust Version Criteria

description: A definition of min, max and/or specific rust version

description: Minimum Rust version

$ref: #/definitions/semver

description: Maximum Rust version

description: Exact Rust version

title: List of Files

description: List of absolute path files to check they exist. Environment substitution is supported so you can define relative paths

title: File Path

description: File path

title: List of Files

description: List of absolute path files to check they do not exist. Environment substitution is supported so you can define relative paths

title: File Path

description: File path

title: Lists input and output globs

description: If any input file is newer than all output files, the condition is met. Environment substitution is supported so you can define relative paths

description: List of input globs

description: glob

description: List of output globs

description: glob

title: Task

description: A task is a command, script, rust code or other sub tasks to execute. Tasks can have dependencies which are also tasks that will be executed before the task itself.

description: If true, it should ignore all data in the base task

title: Description

description: A description used to document the task

title: Category

description: Category name used to document the task

description: If true, the command/script of this task will not be invoked, but dependencies will be

description: If true, the task is hidden from the list of available tasks and also cannot be invoked directly from CLI

description: If set, this task is documented as deprecated. This can be a boolean or a string deprecation message.

title: Deprecation Message

title: Task Name

description: Extends the specified task as a base task

description: Set to false to specify that this is not a workspace and should not call the task for every member (same as --no-workspace CLI flag)

description: Watch for file changes and invoke the task operation

title: Watch Options

description: Version of cargo-watch to install if it's not already installed

description: Postpone first run until a file changes

title: Glob Pattern

description: Ignore a glob/gitignore-style pattern while watching

description: Do not use .gitignore files while watching

title: List of Paths

description: List of files and folders to watch

title: Path

description: File or folder to watch

description: If provided all condition values must be met in order for the task to be invoked (will not stop dependencies)

title: Script

description: If script exit code is not 0, the command/script of this task will not be invoked, dependencies however will be

description: If true, any error while executing the task will be printed but will not break the build

description: DEPRECATED, replaced with `ignore_errors`

description: The env files to setup before running the task commands

description: The env vars to setup before running the task commands

title: Directory Path

description: The working directory for the task to execute its command/script

title: Task Name

description: If defined, task points to another task and all other properties are ignored

title: Task Name

description: If defined and this platform is Linux, task points to another task and all other properties are ignored (takes precedence over `alias` on Linux)

title: Task Name

description: If defined and this platform is Windows, task points to another task and all other properties are ignored (takes precedence over `alias` on Windows)

title: Task Name

description: If defined and this platform is Mac, task points to another task and all other properties are ignored (takes precedence over `alias` on Mac)

description: Indicates the provided crate needs to be installed (if needed) before running the task

description: If set to false, will disable crate installation from the base task

title: Crate Name

description: Name of the crate to install

title: Crate Install Options

description: Instructions on how to install a crate

title: Crate Name

description: Name of the crate to install

title: Component Name

description: The component to install via rustup

title: File Name

description: The binary file name to be used to test if the crate is already installed

title: Args

description: Arguments used to check whether a crate or rustup component is installed.

description: Minimum version of installed crate before it needs to be reinstalled

description: Exact version of installed crate

title: Install Command

description: The alternative cargo install command to install the crate

title: Component Install Options

description: Instructions on how to install a rustup component

title: Component Name

description: The component to install via rustup

title: File Name

title: Args

title: Plugin Install Options

description: Instructions on how to install a cargo plugin

title: Crate Name

description: Name of the crate to install

title: Args

description: Additional cargo install args

description: Provided script will be executed before running the task

title: File Name

description: The command to execute for this task

title: Args

description: The args for the executed command

description: If `command` is not defined, but `script` is defined, the provided script will be executed

title: Script Runner

description: The script attribute may hold non OS scripts, for example rust code to be compiled and executed. In order to use non OS script runners, you must define the special script_runner with the @ prefix.

title: Args

description: The script runner arguments before the script file path

title: File Extension

description: The file extension to use for the script

description: Run a task as a sub-task at the end of executing this task

title: Task Name

description: Name of the sub-task to execute

title: Task Name

description: Name(s) of the sub-task to execute

title: List of Task Names

title: Task Name

description: Fork the sub-task into a a new subprocess

description: Run tasks in parallel

title: Task Name

description: A task to run after all specified sub-tasks have completed

title: Conditional Tasks

description: Conditional sub-task selector

description: Sub-task routing information

title: Task Name

description: Name(s) of the sub-task to execute

title: List of Task Names

title: Task Name

description: Run tasks in parallel

title: Task Name

title: Script

description: If script exit code is not 0, the sub tasks will not be invoked

title: List of Tasks

description: A list of tasks to execute before this task

title: Task Name

description: The name of a task in this file

title: External Task

description: A task dependency potentially in another file

title: Task Name

description: The task name to execute

title: File Path

description: The path to the makefile the task resides in

title: Toolchain

description: The rust toolchain used to invoke the command or install the needed crates/components

description: Override task if runtime OS is Linux (takes precedence over alias)

description: Override task if runtime OS is Windows (takes precedence over alias)

description: Override task if runtime OS is Mac (takes precedence over alias)

description: A schema for cargo-make makefiles

title: Extend External Makefile

description: Extend an external makefile by importing its tasks and properties to this file. Paths are relative to this makefile

title: File Path

description: File path to external makefile relative to this file

title: External Makefile List

description: List of external makefiles to extend

title: Config

description: Configuration options for this makefile

description: If true, the default core tasks will not be loaded

description: If true, the Git related environment variables will not be loaded

description: If true, the rust related environment variables will not be loaded

description: If true, the current crate related environment variables will not be loaded

description: Options to modify all the core tasks

description: If true, all core tasks will be set to private (default false)

title: Namespace

description: If set to some value, all core tasks are modified to: `namespace::name`

title: Task Name

description: Init task name which will be invoked at the start of every run

title: Task Name

description: End task name which will be invoked at the end of every run

title: Task Name

description: The name of the task to run in case of any error during the invocation of the flow

title: Task Name

description: The name of the task which runs legacy migration flows

title: List of Profiles

description: Additional profile names to load

title: Profile

description: Additional profile name to load

description: Minimum cargo-make/makers version

description: The default value for the `workspace` value of tasks in this makefile

description: Set to true to reduce console output for non CI execution

description: Set to true to print time summary at the end of the flow

description: Automatically load cargo aliases as cargo-make tasks

title: Crate

description: The project information member (used by workspaces)

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Linux.

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Windows.

description: Invoked while loading the descriptor file but before loading any extended descriptor. Takes precedence over `load_script` if runtime OS is Mac.

description: The environment files to setup before running any tasks

title: List of Env Scripts

description: The environment scripts to execute after environment files and the env block. These scripts can be used to run anything needed before starting up the flow.

description: Env script

description: The environment variables to setup before running any tasks

description: Task definitions

title: Makefile.toml


$ref: #/definitions/JReleaserModel

enum: ALWAYS NEVER RELEASE PRERELEASE RELEASE_PRERELEASE SNAPSHOT

$ref: #/definitions/Active

$ref: #/definitions/ArticleAnnouncer

$ref: #/definitions/BlueskyAnnouncer

$ref: #/definitions/HttpAnnouncers

$ref: #/definitions/WebhooksAnnouncer

$ref: #/definitions/DiscordAnnouncer

description: announce.discord is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/DiscourseAnnouncer

$ref: #/definitions/DiscussionsAnnouncer

$ref: #/definitions/GitterAnnouncer

description: announce.gitter is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/GoogleChatAnnouncer

description: announce.googleChat is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/HttpAnnouncerMap

$ref: #/definitions/HttpAnnouncer

$ref: #/definitions/LinkedinAnnouncer

$ref: #/definitions/SmtpAnnouncer

description: announce.mail is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/MastodonAnnouncer

$ref: #/definitions/MattermostAnnouncer

description: announce.mattermost is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/OpenCollectiveAnnouncer

$ref: #/definitions/SdkmanAnnouncer

$ref: #/definitions/SlackAnnouncer

$ref: #/definitions/TeamsAnnouncer

description: announce.teams is deprecated since 1.4.0 and will be removed in 2.0.0

$ref: #/definitions/TelegramAnnouncer

$ref: #/definitions/TwitterAnnouncer

$ref: #/definitions/WebhookAnnouncerMap

$ref: #/definitions/WebhookAnnouncer

$ref: #/definitions/ZulipAnnouncer

$ref: #/definitions/CommitAuthor

$ref: #/definitions/Properties

$ref: #/definitions/Icon

$ref: #/definitions/AppImageRepository

$ref: #/definitions/Screenshot

enum: NEVER ALWAYS WARN FORCE

$ref: #/definitions/Artifact

$ref: #/definitions/DistributionType

$ref: #/definitions/FileSet

$ref: #/definitions/Glob

$ref: #/definitions/ArchiveOptions

$ref: #/definitions/Platform

enum: ASC BAT CMD DEB DMG EXE JAR MSI NUGET PKG PS1 RPM SH SIG TAR TAR_BZ2 TAR_GZ TAR_XZ TAR_ZST TBZ2 TGZ TXZ ZIP ZST

description: JReleaser 1.7.0

enum: MSIX MSI APPX EXE ZIP INNO NULLSOFT WIX BURN PWA

enum: SEMVER CALVER CHRONVER JAVA_RUNTIME JAVA_MODULE CUSTOM