Native Image

Creates a Native Image binary using GraalVM Native Image.

You need a local installation of GraalVM. JReleaser will not install GraalVM for you, however it can install the native-image command if needed. You may configure the JDKs Maven Plugin or the JDKs Gradle Plugin to downloads a GraalVM distribution.

Configuration

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
assemble:
  # 
  nativeImage:
    # Assemblers require a name.
    # 
    app:

      # Enables or disables the assembler.
      # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      # Defaults to `NEVER`.
      #  
      active: ALWAYS

      # Export the assembled artifacts as a matching named distribution.
      # Defaults to `true`.
      # 
      exported: true

      # The stereotype of this assembler.
      # Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
      # Defaults to `#{project.stereotype}`.
      # 
      stereotype: CLI

      # Additional properties used when evaluating templates.
      #  
      extraProperties:
        # Key will be capitalized and prefixed with `nativeImage`, i.e, `nativeImageFoo`.
        foo: bar

      # 
      platform:
        # Key value pairs.
        # Keys match a full platform or an os.name, os.arch.
        # Same rules apply as in Platform.
        # 
        replacements:
          osx-x86_64: mac
          aarch_64: aarch64
          x86_64: amd64
          linux_musl: alpine

      # Name of the executable launcher.
      # If left undefined, will use `#{assembler.name}`.
      # 
      executable: app

      # Name of the generated image.
      # If left undefined, will use
      # `#{assembler.executable}-#{project.version}`.
      # Generated artifacts always have the platform as suffix.
      #  
      imageName: 'app-{{projectVersion}}'

      # Name transformation of the generated image.
      # Transformed artifacts always have the platform as suffix.
      #  
      imageNameTransform: 'app-{{projectEffectiveVersion}}'

      # 
      archiving:

        # If set to `true`, generates an archive and assembles a BINARY distribution.
        # If set to `false`, does *not* generate an archive and assembles a FLAT_BINARY distribution.
        # Defaults to `true`.
        enabled: true

        # Archive format to use.
        # Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
        # Defaults to `ZIP`.
        # 
        format: TGZ

      # Includes the default matrix.
      # 
      applyDefaultMatrix: false

      # Configures matrix variables.
      # 
      matrix:
        vars:
          os: [ linux, osx, windows ]
          arch: [ arm64, amd64 ]
        rows:
          - { os: linux, arch: arm64 }
          - { os: linux, arch: amd64 }
          - { os: osx, arch: arm64 }
          - { os: osx, arch: amd64 }
          - { os: windows, arch: arm64 }
          - { os: windows, arch: amd64 }

      # Define a pattern for parameterizable graalJdks
      #  
      graalJdkPattern:
        path: path/to/jdk

      # List of Graal JDKs.
      #  
      graalJdks:
        - path: path/to/jdk
          platform: osx-x86_64
        - path: path/to/jdk
          platform: linux-x86_64

      # A list of build arguments.
      # The `-H:Name` argument will always be replaced with the
      # value of $executable.
      # 
      args:
        - '--install-exit-handlers'

      # A list of additional GraalVM components to be installed.
      # 
      components:
        - 'espresso'

      # Compress the resulting executable with UPX.
      # 
      upx:
        # Enables or disables UPX.
        # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        # Defaults to `NEVER`.
        # 
        active: ALWAYS

        # Tool version.
        # 
        version: '3.96'

        # A list of arguments.
        # 
        args:
          - '-f'

      # 
      linuxX86:
        # A list of arguments.
        # 
        args:
          - '--static'

      # 
      windowsX86:
        # A list of arguments.
        # 
        args:
          - '--foo'

      # 
      macosX86:
        # A list of arguments.
        # 
        args:
          - '--bar'

      # 
      linuxArm:
        # A list of arguments.
        # 
        args:
          - '--static'

      # 
      macosArm:
        # A list of arguments.
        # 
        args:
          - '--bar'

      # 
      options:
        # Timestamp to use for each entry.
        # Must follow ISO-8601 +HH:MM timezone offset.
        # Example: 2023-03-08T12:56:33.024578+01:00
        # Defaults to timestamp for latest git commit or current time.
        # 
        timestamp: '2020-01-01T00:00:00.000000+00:00'

        # Set longFileMode for tar archives.
        # Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
        # Defaults to `ERROR`.
        # 
        longFileMode: POSIX

        # Set bigNumberMode for tar archives.
        # Possible values are [`ERROR`, `GNU`, `POSIX`].
        # Defaults to `ERROR`.
        # 
        bigNumberMode: POSIX

      # The executable JAR that contains the application.
      #  
      mainJar:
        path: path/to/app.jar

      # Defines a list of additional JARs as globs.
      # 
      jars:
          # The pattern to use.
          # May use glob or regex pattern syntax.
          #  
        - pattern: path/to/**/*.jar

      # 
      java:
        # Name of main module (if any).
        # Define only if the application is modular.
        # 
        mainModule: com.acme.demo

        # The application's entry point.
        # If left undefined, will use `#{project.java.mainClass}`.
        # 
        mainClass: com.acme.Main

        # Options to pass to the Java runtime
        # 
        jvmOptions:
          # Included in all scripts
          #  
          universal:
            - -Dprop=value
          # Included in all non Windows scripts
          #  
          unix:
            - -Dprop=value
          # Included in all non Windows (except OSX) scripts
          #  
          linux:
            - -Dprop=value
          # Included only in OSX scripts
          #  
          osx:
            - -Dprop=value
          # Included in Windows scripts
          #  
          windows:
            - -Dprop=value

        # Environment variables used in launch scripts.
        # 
        environmentVariables:
          # Included in all scripts
          #  
          universal:
            KEY: value
          # Included in all non Windows scripts
          #  
          unix:
            KEY: value
          # Included in all non Windows (except OSX) scripts
          #  
          linux:
            KEY: value
          # Included only in OSX scripts
          #  
          osx:
            KEY: value
          # Included in Windows scripts
          #  
          windows:
            KEY: value

        # Maven coordinates: groupId.
        # If left undefined, will use `#{project.java.groupId}`.
        # 
        groupId: com.acme

        # Maven coordinates: artifactId.
        # If left undefined, will use `#{project.java.artifactId}`.
        # 
        artifactId: app

        # The minimum Java version required by consumers to run the application.
        # If left undefined, will use `#{project.java.version}`.
        # 
        version: 8

        # Identifies the project as being member of a multi-project build.
        # If left undefined, will use `#{project.java.multiProject}`.
        # 
        multiProject: false

        # Additional properties used when evaluating templates.
        # 
        extraProperties:
          # Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
          foo: bar


      # Directory with file templates used to prepare the assembler.
      # Defaults to `src/jreleaser/assemblers/#{distribution.name}/nativeImage`.
      # If specified, path must exist.
      # 
      templateDirectory: path/to/nativeImage/templates

      # List of template files to be skipped.
      # Value may be an exact match or a regex.
      # 
      skipTemplates:
        - README.md.tpl

      # Defines a list of additional files as artifacts.
      # These files will be added to the assembled archive.
      #  
      artifacts:
        - path: path/to/file
        - path: path/to/another_file
          transform: path/inside/archive
        - path: path/to/platform/specific/file
          platform: osx-x86_64

      # Defines a list of additional files as globs.
      # These files will be added to the assembled archive.
      # 
      files:
          # The pattern to use.
          # May use glob or regex pattern syntax.
          #  
        - pattern: path/to/**/*.txt

      # Defines a list of additional files as filesets.
      # These files will be added to the assembled archive.
      # 
      fileSets:
          # The input directory to copy files from.
          #  
        - input: path/to/input/directory

          # The target path inside the archive.
          # If left undefined, defaults to the root of the archive.
          #  
          output: path/to/archive/entry

          # Fail if the given `input` does not exist.
          # Defaults to `true`.
          # 
          failOnMissingInput: false

          # A set of files and directory to include.
          #  
          includes:
            - 'name_or_regex'

          # A set of files and directory to exclude.
          #  
          excludes:
            - 'name_or_regex'

          # Additional properties used when evaluating templates.
          #  
          extraProperties:
            # Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
            foo: bar

      # 
      swid:
        # Tags require a name.
        # 
        mytag:

          # Enables or disables the tag.
          # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          # Defaults to `NEVER`.
          #  
          active: ALWAYS

          # Reference to a common tag.
          # 
          tagRef: swid-tag

          # Path where the tag file will be placed.
          # Defaults to `SWIDTAG`.
          # 
          path: SWID

          # A globally unique identifier and should be assigned a GUID reference.
          # Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
          # 
          tagId: c526ec37-2715-328e-8bbc-4eb5a9f47c98

          # Indicates if a specific release of a software product has more than one tag that can represent that specific release.
          # Defaults to `1`.
          # 
          tagVersion: 2

          # Language used in the tag document.
          # Defaults to `en-US`.
          # 
          lang: de

          # If this SWID tag is a collection of information that describes the pre-installation data of software component.
          # Defaults to `false`.
          # 
          corpus: true

          # If this SWID tag describes a product patch or modification to a different software element.
          # Defaults to `false`.
          # 
          patch: false

          # List of organizations related to the software component referenced by this SWID tag.
          # 
          entities:
              # name of the organization claiming a particular role in the SWID tag.
              # 
            - name: Acme

              # URI of the claiming organization.
              # Defaults to `http://invalid.unavailable`.
              # 
              regid: https://acme.com

              # The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
              # The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
              # include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
              # Other roles will be defined as the market uses the SWID tags.
              # Defaults to [`tagCreator`, `softwareCreator`].
              # 
              roles:
                - tagCreator
                - softwareCreator
# Assemblers require a name.
# 
[assemble.nativeImage.app]

  # Enables or disables the assembler.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # Export the assembled artifacts as a matching named distribution.
  # Defaults to `true`.
  # 
  exported = true

  # The stereotype of this assembler.
  # Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
  # Defaults to `#{project.stereotype}`.
  # 
  stereotype = "CLI"

  # Additional properties used when evaluating templates.
  #  
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `nativeImage`, i.e, `nativeImageFoo`.

  # Key value pairs.
  # Keys match a full platform or an os.name, os.arch.
  # Same rules apply as in Platform.
  # 
  [assemble.nativeImage.app.platform.replacements]
    osx-x86_64 = "mac"
    aarch_64 = "aarch64"
    x86_64 = "amd64"
    linux_musl = "alpine"

  # Name of the executable launcher.
  # If left undefined, will use `#{assembler.name}`.
  # 
  executable = "app"

  # Name of the generated image.
  # If left undefined, will use
  # `#{assembler.executable}-#{project.version}`.
  # Generated artifacts always have the platform as suffix.
  #  
  imageName = "app-{{projectVersion}}"

  # Name transformation of the generated image.
  # Transformed artifacts always have the platform as suffix.
  #  
  imageNameTransform = "app-{{projectEffectiveVersion}}"

  # If set to `true`, generates an archive and assembles a BINARY distribution.
  # If set to `false`, does *not* generate an archive and assembles a FLAT_BINARY distribution.
  # Defaults to `true`.
  archiving.enabled: true

  # Archive format to use.
  # Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
  # Defaults to `ZIP`.
  # 
  archiving.format = "TGZ"

  # Includes the default matrix.
  # 
  applyDefaultMatrix = false

  # Configures matrix variables.
  # 
  matrix.vars.os = [ "linux", "osx", "windows" ]
  matrix.vars.arch= [ "arm64", "amd64" ]
  rows = [{ os = "linux", arch = "arm64" },
          { os = "linux", arch = "amd64" },
          { os = "osx", arch = "arm64" },
          { os = "osx", arch = "amd64" },
          { os = "windows", arch = "arm64" },
          { os = "windows", arch = "amd64" }]

  # Define a pattern for parameterizable graalJdks
  #  
  graalJdkPattern.path = "path/to/jdk"

  # List of Graal JDKs.
  #  
  graalJdks = [
    { path = "path/to/jdk", platform = "osx-x86_64" },
    { path = "path/to/jdk", platform = "linux-x86_64" }]

  # A list of build arguments.
  # The `-H:Name` argument will always be replaced with the
  # value of $executable.
  # 
  args = ["--install-exit-handlers"]

  # A list of additional GraalVM components to be installed.
  # 
  components = ["espresso"]

  # Compress the resulting executable with UPX.
  # 
  [assemble.nativeImage.app.upx]
    # Enables or disables UPX.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `NEVER`.
    # 
    active = "ALWAYS"

    # Tool version.
    # 
    version = "3.96"

    # A list of arguments.
    # 
    args = ["-f]

  # 
  [assemble.nativeImage.app.linuxX86]
    # A list of arguments.
    # 
    args = ["--static]

  # 
  [assemble.nativeImage.app.windowsX86]
    # A list of arguments.
    # 
    args = ["--foo]

  # 
  [assemble.nativeImage.app.macosX86]
    # A list of arguments.
    # 
    args = ["--bar]

  # 
  [assemble.nativeImage.app.linuxArm]
    # A list of arguments.
    # 
    args = ["--static]

  # 
  [assemble.nativeImage.app.macosArm]
    # A list of arguments.
    # 
    args = ["--bar]

  # Timestamp to use for each entry.
  # Must follow ISO-8601 +HH:MM timezone offset.
  # Example: 2023-03-08T12:56:33.024578+01:00
  # Defaults to timestamp for latest git commit or current time.
  # 
  options.timestamp = "2020-01-01T00:00:00.000000+00:00"

  # Set longFileMode for tar archives.
  # Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
  # Defaults to `ERROR`.
  # 
  options.longFileMode = "POSIX"

  # Set bigNumberMode for tar archives.
  # Possible values are [`ERROR`, `GNU`, `POSIX`].
  # Defaults to `ERROR`.
  # 
  options.bigNumberMode = "POSIX"

  # The executable JAR that contains the application.
  #  
  mainJar = { path = "path/to/app.jar" }

  # Defines a list of additional JARs as globs.
  # 
  [[assemble.jlink.app.jars]]
    # The pattern to use.
    # May use glob or regex pattern syntax.
    #  
    pattern = "path/to/**/*.jar"

  # Name of main module (if any).
  # Define only if the application is modular.
  # 
  java.mainModule = "com.acme.demo"

  # The application's entry point.
  # If left undefined, will use `#{project.java.mainClass}`.
  # 
  java.mainClass = "com.acme.Main"

  # Options to pass to the Java runtime

  # Included in all scripts
  #  
  java.jvmOptions.universal = ["-Dprop=value"]

  # Included in all non Windows scripts
  #  
  java.jvmOptions.unix = ["-Dprop=value"]

  # Included in all non Windows (except OSX) scripts
  #  
  java.jvmOptions.linux = ["-Dprop=value"]

  # Included only in OSX scripts
  #  
  java.jvmOptions.osx = ["-Dprop=value"]

  # Included in Windows scripts
  #  
  java.jvmOptions.windows = ["-Dprop=value"]

  # Environment variables used in launch scripts.

  # Included in all scripts
  #  
  java.environmentVariables.universal.KEY = "value"

  # Included in all non Windows scripts
  #  
  java.environmentVariables.unix.KEY = "value"

  # Included in all non Windows (except OSX) scripts
  #  
  java.environmentVariables.linux.KEY = "value"

  # Included only in OSX scripts
  #  
  java.environmentVariables.osx.KEY = "value"

  # Included in Windows scripts
  #  
  java.environmentVariables.windows.KEY = "value"

  # Maven coordinates: groupId.
  # If left undefined, will use `#{project.java.groupId}`.
  # 
  java.groupId = "com.acme"

  # Maven coordinates: artifactId.
  # If left undefined, will use `#{project.java.artifactId}`.
  # 
  java.artifactId = "app"

  # The minimum Java version required by consumers to run the application.
  # If left undefined, will use `#{project.java.version}`.
  # 
  java.version = "8"

  # Identifies the project as being member of a multi-project build.
  # If left undefined, will use `#{project.java.multiProject}`.
  # 
  java.multiProject = false

  # Additional properties used when evaluating templates.
  # 
  java.extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.

  # Directory with file templates used to prepare the assembler.
  # Defaults to `src/jreleaser/assemblers/#{distribution.name}/nativeImage`.
  # If specified, path must exist.
  # 
  templateDirectory = "path/to/nativeImage/templates"

  # List of template files to be skipped.
  # Value may be an exact match or a regex.
  # 
  skipTemplates = [ "README.md.tpl" ]

  # Defines a list of additional files as artifacts.
  # These files will be added to the assembled archive.
  #  
  [[assemble.nativeImage.app.artifacts]]
    path = "path/to/file"
  [[assemble.nativeImage.app.artifacts]]
    path = "path/to/another_file"
    transform = "path/inside/archive"
  [[assemble.nativeImage.app.artifacts]]
    path = "path/to/platform/specific/file"
    platform = "osx-x86_64"

  # Defines a list of additional files as globs.
  # These files will be added to the assembled archive.
  # 
  [[assemble.nativeImage.app.files]]
    # The pattern to use.
    # May use glob or regex pattern syntax.
    #  
    pattern = "path/to/**/*.txt"

  # Defines a list of additional files as filesets.
  # These files will be added to the assembled archive.
  # 
  [[assemble.nativeImage.app.fileSets]]
    # The input directory to copy files from.
    #  
    input = "path/to/input/directory"

    # The target path inside the archive.
    # If left undefined, defaults to the root of the archive.
    #  
    output = "path/to/archive/entry"

    # Fail if the given `input` does not exist.
    # Defaults to `true`.
    # 
    failOnMissingInput = false

    # A set of files and directory to include.
    #  
    includes = ["name_or_regex"]

    # A set of files and directory to exclude.
    #  
    excludes = ["name_or_regex"]

    # Additional properties used when evaluating templates.
    #  
    [[assemble.nativeImage.app.fileSets.extraProperties]]
      # Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
      foo: bar

  # 
  [assemble.nativeImage.app.swid]
    # Enables or disables the tag.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `NEVER`.
    #  
    active = "ALWAYS"

    # Reference to a common tag.
    # 
    tagRef = "swid-tag"

    # Path where the tag file will be placed.
    # Defaults to `SWIDTAG`.
    # 
    path = "SWID"

    # A globally unique identifier and should be assigned a GUID reference.
    # Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
    # 
    tagId = "c526ec37-2715-328e-8bbc-4eb5a9f47c98"

    # Indicates if a specific release of a software product has more than one tag that can represent that specific release.
    # Defaults to `1`.
    # 
    tagVersion = 2

    # Language used in the tag document.
    # Defaults to `en-US`.
    # 
    lang = "de"

    # If this SWID tag is a collection of information that describes the pre-installation data of software component.
    # Defaults to `false`.
    # 
    corpus = true

    # If this SWID tag describes a product patch or modification to a different software element.
    # Defaults to `false`.
    # 
    patch = false

    # List of organizations related to the software component referenced by this SWID tag.
    # 
    [[assemble.nativeImage.app.swid.entities]]
      # name of the organization claiming a particular role in the SWID tag.
      # 
      name = "Acme"

      # URI of the claiming organization.
      # Defaults to `http://invalid.unavailable`.
      # 
      regid = "https://acme.com"

      # The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
      # The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
      # include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
      # Other roles will be defined as the market uses the SWID tags.
      # Defaults to [`tagCreator`, `softwareCreator`].
      # 
      roles = ["tagCreator", "softwareCreator"]
{
  // 
  "assemble": {
    // 
    "nativeImage": {
      // Assemblers require a name.
      // 
      "app": {

        // Enables or disables the assembler.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        //  
        "active": "ALWAYS",

        // Export the assembled artifacts as a matching named distribution.
        // Defaults to `true`.
        // 
        "exported": true,

        // The stereotype of this assembler.
        // Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
        // Defaults to `#{project.stereotype}`.
        // 
        "stereotype": "CLI",

        // Additional properties used when evaluating templates.
        //  
        "extraProperties": {
          // Key will be capitalized and prefixed with `nativeImage`, i.e, `nativeImageFoo`.
          "foo": "bar"
        },

        // 
        platform: {
          // Key value pairs.
          // Keys match a full platform or an os.name, os.arch.
          // Same rules apply as in Platform.
          // 
          "replacements": {
            "osx-x86_64": "mac",
            "aarch_64": "aarch64",
            "x86_64": "amd64",
            "linux_musl": "alpine"
          }
        },

        // Name of the executable launcher.
        // If left undefined, will use `#{assembler.name}`.
        // 
        "executable": "app",

        // Name of the generated image.
        // If left undefined, will use
        // `#{assembler.executable}-#{project.version}`.
        // Generated artifacts always have the platform as suffix.
        //  
        "imageName": "app-{{projectVersion}}",

        // Name transformation of the generated image.
        // Transformed artifacts always have the platform as suffix.
        //  
        "imageNameTransform": "app-{{projectEffectiveVersion}}",

        // 
        "archiving": {
          // If set to `true`, generates an archive and assembles a BINARY distribution.
          // If set to `false`, does *not* generate an archive and assembles a FLAT_BINARY distribution.
          // Defaults to `true`.
          "enabled": true,

          // Archive format to use.
          // Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
          // Defaults to `ZIP`.
          // 
          "format": "TGZ"
        },

        // Includes the default matrix.
        // 
        "applyDefaultMatrix": false,

        // Configures matrix variables.
        // 
        "matrix": {
          "vars": {
            "os": [ "linux", "osx", "windows" ],
            "arch": [ "arm64", "amd64" ]
          },
          "rows": [
            { "os": "linux", "arch": "arm64" },
            { "os": "linux", "arch": "amd64" },
            { "os": "osx", "arch": "arm64" },
            { "os": "osx", "arch": "amd64" },
            { "os": "windows", "arch": "arm64" },
            { "os": "windows", "arch": "amd64" }
          ]
        },

        // Define a pattern for parameterizable graalJdks
        //  
        "graalJdkPattern": {
          "path": "path/to/jdk"
        },

        // List of Graal JDKs.
        //  
        "graalJdks": [
          {
            "path": "path/to/jdk",
            "platform": "osx-x86_64"
          },
          {
            "path": "path/to/jdk",
            "platform": "linux-x86_64"
          }
        ],

        // A list of build arguments.
        // The `-H:Name` argument will always be replaced with the
        // value of $executable.
        // 
        "args": [
          "--install-exit-handlers"
        ],

        // A list of additional GraalVM components to be installed.
        // 
        "components": [
          "espresso"
        ],

        // Compress the resulting executable with UPX.
        // 
        "upx": {
          // Enables or disables UPX.
          // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          // Defaults to `NEVER`.
          // 
          "active": "ALWAYS",

          // Tool version.
          // 
          "version": "3.96",

          // A list of arguments.
          // 
          "args": ["-f"]
        },

        // 
        "linuxX86": {
          // A list of arguments.
          // 
          "args": ["--static"]
        },

        // 
        "windowsX86": {
          // A list of arguments.
          // 
          "args": ["--foo"]
        },

        // 
        "macosX86": {
          // A list of arguments.
          // 
          "args": ["--bar"]
        },

        // 
        "linuxArm": {
          // A list of arguments.
          // 
          "args": ["--static"]
        },

        // 
        "macosArm": {
          // A list of arguments.
          // 
          "args": ["--bar"]
        },

        // 
        "options": {
          // Timestamp to use for each entry.
          // Must follow ISO-8601 +HH:MM timezone offset.
          // Example: 2023-03-08T12:56:33.024578+01:00
          // Defaults to timestamp for latest git commit or current time.
          // 
          "timestamp": "2020-01-01T00:00:00.000000+00:00",

          // Set longFileMode for tar archives.
          // Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
          // Defaults to `ERROR`.
          // 
          "longFileMode": "POSIX",

          // Set bigNumberMode for tar archives.
          // Possible values are [`ERROR`, `GNU`, `POSIX`].
          // Defaults to `ERROR`.
          // 
          "bigNumberMode": "POSIX"
        },

        // The executable JAR that contains the application.
        //  
        "mainJar": {
          "path": "path/to/app.jar"
        },

        // Defines a list of additional JARs as globs.
        // 
        "jars": [
          {
            // The pattern to use.
            // May use glob or regex pattern syntax.
            //  
            "pattern": "path/to/**/*.jar"
          }
        ],

        // 
        "java": {
          // Name of main module (if any).
          // Define only if the application is modular.
          // 
          "mainModule": "com.acme.demo",

          // The application's entry point.
          // If left undefined, will use `#{project.java.mainClass}`.
          // 
          "mainClass": "com.acme.Main",

          // Options to pass to the Java runtime
          // 
          "jvmOptions": {
            // Included in all scripts
            //  
            "universal": [
              "-Dprop=value"
            ],
            // Included in all non Windows scripts
            //  
            "unix": [
              "-Dprop=value"
            ],
            // Included in all non Windows (except OSX) scripts
            //  
            "linux": [
              "-Dprop=value"
            ],
            // Included only in OSX scripts
            //  
            "osx": [
              "-Dprop=value"
            ],
            // Included in Windows scripts
            //  
            "windows": [
              "-Dprop=value"
            ]
          },

          // Environment variables used in launch scripts.
          // 
          "environmentVariables": {
            // Included in all scripts
            //  
            "universal": {
              "KEY": "value"
            },
            // Included in all non Windows scripts
            //  
            "unix": {
              "KEY": "value"
            },
            // Included in all non Windows (except OSX) scripts
            //  
            "linux": {
              "KEY": "value"
            },
            // Included only in OSX scripts
            //  
            "osx": {
              "KEY": "value"
            },
            // Included in Windows scripts
            //  
            "windows": {
              "KEY": "value"
            }
          },

          // Maven coordinates: groupId.
          // If left undefined, will use `#{project.java.groupId}`.
          // 
          "groupId": "com.acme",

          // Maven coordinates: artifactId.
          // If left undefined, will use `#{project.java.artifactId}`.
          // 
          "artifactId": "app",

          // The minimum Java version required by consumers to run the application.
          // If left undefined, will use `#{project.java.version}`.
          // 
          "version": "8",

          // Identifies the project as being member of a multi-project build.
          // If left undefined, will use `#{project.java.multiProject}`.
          // 
          "multiProject": false,

          // Additional properties used when evaluating templates.
          // 
          "extraProperties": {
            // Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
            "foo": "bar"
          }
        },

        // Directory with file templates used to prepare the assembler.
        // Defaults to `src/jreleaser/assemblers/#$#{distribution.name}/nativeImage`.
        // If specified, path must exist.
        // 
        "templateDirectory": "path/to/nativeImage/templates",

        // List of template files to be skipped.
        // Value may be an exact match or a regex.
        // 
        "skipTemplates": [
          "README.md.tpl"
        ],

        // Defines a list of additional files as artifacts.
        // These files will be added to the assembled archive.
        //  
        "artifacts": [
          {
            "path": "path/to/file"
          },
          {
            "path": "path/to/another_file",
            "transform": "path/inside/archive"
          },
          {
            "path": "path/to/platform/specific/file",
            "platform": "osx-x86_64"
          }
        ]  ,

        // Defines a list of additional files as globs.
        // These files will be added to the assembled archive.
        // 
        "files": [
          {
            // The pattern to use.
            // May use glob or regex pattern syntax.
            //  
            "pattern": "path/to/**/*.txt"
          }
        ],

        // Defines a list of additional files as filesets.
        // These files will be added to the assembled archive.
        // 
        "fileSets": [
          {
            // The input directory to copy files from.
            //  
            "input": "path/to/input/directory",

            // The target path inside the archive.
            // If left undefined, defaults to the root of the archive.
            //  
            "output": "path/to/archive/entry",

            // Fail if the given `input` does not exist.
            // Defaults to `true`.
            // 
            "failOnMissingInput": false,

            // A set of files and directory to include.
            //  
            "includes": ["name_or_regex"],

            // A set of files and directory to exclude.
            //  
            "excludes": ["name_or_regex"],

            // Additional properties used when evaluating templates.
            //  
            "extraProperties": {
              // Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
              "foo": "bar"
            }
          }
        ],

        // 
        "swid": {
          // Tags require a name.
          // 
          "mytag": {

            // Enables or disables the tag.
            // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
            // Defaults to `NEVER`.
            //  
            "active": "ALWAYS",

            // Reference to a common tag.
            // 
            "tagRef": "swid-tag",

            // Path where the tag file will be placed.
            // Defaults to `SWIDTAG`.
            // 
            "path": "SWID",

            // A globally unique identifier and should be assigned a GUID reference.
            // Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
            // 
            "tagId": "c526ec37-2715-328e-8bbc-4eb5a9f47c98",

            // Indicates if a specific release of a software product has more than one tag that can represent that specific release.
            // Defaults to `1`.
            // 
            "tagVersion": 2,

            // Language used in the tag document.
            // Defaults to `en-US`.
            // 
            "lang": "de",

            // If this SWID tag is a collection of information that describes the pre-installation data of software component.
            // Defaults to `false`.
            // 
            "corpus": true,

            // If this SWID tag describes a product patch or modification to a different software element.
            // Defaults to `false`.
            // 
            "patch": false,

            // List of organizations related to the software component referenced by this SWID tag.
            // 
            "entities": [
              {
                // name of the organization claiming a particular role in the SWID tag.
                // 
                "name": "Acme",

                // URI of the claiming organization.
                // Defaults to `http://invalid.unavailable`.
                // 
                "regid": "https://acme.com",

                // The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
                // The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
                // include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
                // Other roles will be defined as the market uses the SWID tags.
                // Defaults to [`tagCreator`, `softwareCreator`].
                // 
                "roles": [
                  "tagCreator",
                  "softwareCreator"
                ]
              }
            ]
          }
        }
      }
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <assemble>
    <!--
      
    -->
    <nativeImage>
      <!--
        Assemblers require a name.
        
      -->
      <app>
        <!--
          Enables or disables the distribution.
          Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          Defaults to `ALWAYS`.
           
        -->
        <active>ALWAYS</active>

        <!--
          Export the assembled artifacts as a matching named distribution.
          Defaults to `true`.
          
        -->
        <exported>true</exported>

        <!--
          The stereotype of this assembler.
          Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
          Defaults to `#{project.stereotype}`.
          
        -->
        <stereotype>CLI</stereotype>

        <!--
          Additional properties used when evaluating templates.
           
        -->
        <extraProperties>
          <!--
            Key will be capitalized and prefixed with `nativeImage`, i.e, `nativeImageFoo`.
          -->
          <foo>bar</foo>
        </extraProperties>

        <!--
          
        -->
        <platform>

          <!--
            Key value pairs.
            Keys match a full platform or an os.name, os.arch.
            Same rules apply as in Platform.
            
          -->
          <replacements>
            <osx-x86_64>mac</osx-x86_64>
            <aarch_64>aarch64</aarch_64>
            <x86_64>amd64</x86_64>
            <linux_musl>alpine</linux_musl>
          </replacements>
        </platform>

        <!--
          Name of the executable launcher.
          If left undefined, will use `#{assembler.name}`.
          
        -->
        <executable>app</executable>

        <!--
          Name of the generated image.
          If left undefined, will use
          `#{assembler.executable}-#{project.version}`.
          Generated artifacts always have the platform as suffix.
           
        -->
        <imageName>app-{{projectVersion}}</imageName>

        <!--
          Name transformation of the generated image.
          Transformed artifacts always have the platform as suffix.
           
        -->
        <imageNameTransform>app</imageNameTransform>

        <!--
          
        -->
        <archiving>
          <!--
            If set to `true`, generates an archive and assembles a BINARY distribution.
            If set to `false`, does *not* generate an archive and assembles a FLAT_BINARY distribution.
            Defaults to `true`.
          -->
          <enabled>true</enabled>

          <!--
            Archive format to use.
            Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
            Defaults to `ZIP`.
            
          -->
          <format>TGZ</format>
        </archiving>

        <!--
          Archive format to use.
          Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
          Defaults to `ZIP`.
          
        -->
        <archiveFormat>TGZ</archiveFormat>

        <!--
          Includes the default matrix.
          
        -->
        <applyDefaultMatrix>false</applyDefaultMatrix>

        <!--
          Configures matrix variables.
          
        -->
        <matrix>
          <vars>
            <os>
              <e>linux</e>
              <e>osx</e>
              <e>windows</e>
            </os>
            <arch>
              <e>arm64</e>
              <e>amd64</e>
            </arch>
          </vars>
          <rows>
            <row>
              <os>linux</os>
              <arch>arm64</arch>
            </row>
            <row>
              <os>linux</os>
              <arch>amd64</arch>
            </row>
            <row>
              <os>osx</os>
              <arch>arm64</arch>
            </row>
            <row>
              <os>osx</os>
              <arch>amd64</arch>
            </row>
            <row>
              <os>windows</os>
              <arch>arm64</arch>
            </row>
            <row>
              <os>windows</os>
              <arch>amd64</arch>
            </row>
          </rows>
        </matrix>

        <!--
          Define a pattern for parameterizable graalJdks
           
        -->
        <graalJdkPattern>
          <path>path/to/jdk</path>
        </graalJdkPattern>

        <!--
          List of Graal JDKs.
           
        -->
        <graalJdks>
          <graalJdk>
            <path>path/to/jdk</path>
            <platform>osx-x86_64</platform>
          </graalJdk>
          <graalJdk>
            <path>path/to/jdk</path>
            <platform>linux-x86_64</platform>
          </graalJdk>
        </graalJdks>

        <!--
          A list of build arguments.
          The `-H =Name` argument will always be replaced with the
          value of $executable.
          
        -->
        <args>
          <arg>--install-exit-handlers</arg>
        </args>

        <!--
          A list of additional GraalVM components to be installed.
          
        -->
        <components>
          <component>espresso</component>
        <components>

        <!--
          Compress the resulting executable with UPX.
          
        --->
        <upx>
          <!--
            Enables or disables UPX.
            Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
            Defaults to `NEVER`.
            
          -->
          <active>ALWAYS</active>

          <!--
            Tool version.
            
          -->
          <version>3.96</version>

          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>-f</arg>
          </args>
        </upx>

        <!--
          
        --->
        <linuxX86>
          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>--static</arg>
          </args>
        </linuxX86>

        <!--
          
        --->
        <windowsX86>
          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>--foo</arg>
          </args>
        </windowsX86>

        <!--
          
        --->
        <macosX86>
          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>--bar</arg>
          </args>
        </macosX86>

        <!--
          
        --->
        <linuxArm>
          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>--static</arg>
          </args>
        </linuxArm>

        <!--
          
        --->
        <macosArm>
          <!--
            A list of arguments.
            
          -->
          <args>
            <arg>--bar</arg>
          </args>
        </macosArm>

        <!--
          
        -->
        <options>
          <!--
            Timestamp to use for each entry.
            Must follow ISO-8601 +HH:MM timezone offset.
            Example: 2023-03-08T12:56:33.024578+01:00
            Defaults to timestamp for latest git commit or current time.
            
          -->
          <timestamp>2020-01-01T00:00:00.000000+00:00</timestamp>

          <!--
            Set longFileMode for tar archives.
            Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
            Defaults to `ERROR`.
            
          -->
          <longFileMode>POSIX</longFileMode>

          <!--
            Set bigNumberMode for tar archives.
            Possible values are [`ERROR`, `GNU`, `POSIX`].
            Defaults to `ERROR`.
            
          -->
          <bigNumberMode>POSIX</bigNumberMode>
        </options>

        <!--
          The executable JAR that contains the application.
           
        -->
        <mainJar>
          <path>path/to/app.jar</path>
        </mainJar>

        <!--
          Defines a list of additional JARs as globs.
          
        -->
        <jars>
          <jar>
            <!--
              The pattern to use.
              May use glob or regex pattern syntax.
               
            -->
            <pattern>path/to/**/*.jar</pattern>
          </jar>
        </jars>

        <!--
          
        -->
        <java>
          <!--
            Name of main module (if any).
            Define only if the application is modular.
            
          -->
          <mainModule>com.acme.demo</mainModule>

          <!--
            The application's entry point.
            If left undefined, will use `#{project.java.mainClass}`.
            
          -->
          <mainClass>com.acme.Main</mainClass>

          <!--
            Options to pass to the Java runtime
            
          -->
          <jvmOptions>
            <!--
              Included in all scripts
               
            -->
            <universal>-Dprop=value</universal>
            <!--
              Included in all non Windows scripts
               
            -->
            <unix>-Dprop=value</unix>
            <!--
              Included in all non Windows (except OSX) scripts
               
            -->
            <linux>-Dprop=value</linux>
            <!--
              Included only in OSX scripts
               
            -->
            <osx>-Dprop=value</osx>
            <!--
              Included in Windows scripts
               
            -->
            <windows>-Dprop=value</windows>
          </jvmOptions>

          <!--
            Environment variables used in launch scripts.
            
          -->
          <environmentVariables>
            <!--
              Included in all scripts
               
            -->
            <universal>
              <KEY>value</KEY>
            </universal>
            <!--
              Included in all non Windows scripts
               
            -->
            <unix>
              <KEY>value</KEY>
            </unix>
            <!--
              Included in all non Windows (except OSX) scripts
               
            -->
            <linux>
              <KEY>value</KEY>
            </linux>
            <!--
              Included only in OSX scripts
               
            -->
            <osx>
              <KEY>value</KEY>
            </osx>
            <!--
              Included in Windows scripts
               
            -->
            <windows>
              <KEY>value</KEY>
            </windows>
          </environmentVariables>

          <!--
            Maven coordinates>groupId.
            If left undefined, will use `#{project.java.groupId}`.
            
          -->
          <groupId>com.acme</groupId>

          <!--
            Maven coordinates>artifactId.
            If left undefined, will use `#{project.java.artifactId}`.
            
          -->
          <artifactId>app</artifactId>

          <!--
            The minimum Java version required by consumers to run the application.
            If left undefined, will use `#{project.java.version}`.
            
          -->
          <version>8</version>

          <!--
            Identifies the project as being member of a multi-project build.
            If left undefined, will use `#{project.java.multiProject}`.
            
          -->
          <multiProject>false</multiProject>

          <!--
            Additional properties used when evaluating templates.
            
          -->
          <extraProperties>
            <!--
              Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
            -->
            <foo>bar</foo>
          </extraProperties>
        </java>

        <!--
          Directory with file templates used to prepare the assembler.
          Defaults to `src/jreleaser/assemblers/#{distribution.name}/nativeImage`.
          If specified, path must exist.
          
        -->
        <templateDirectory>path/to/nativeImage/templates</templateDirectory>

        <!--
          List of template files to be skipped.
          Value may be an exact match or a regex.
          
        -->
        <skipTemplates>
          <skipTemplate>README.md.tpl</skipTemplate>
        </skipTemplates>

        <!--
          Defines a list of additional files as artifacts.
          These files will be added to the assembled archive.
           
        -->
        <artifacts>
          <artifact>
            <path>path/to/file</path>
          </artifact>
          <artifact>
            <path>path/to/another_file</path>
            <transform>path/inside/archive</transform>
          </artifact>
          <artifact>
            <path>path/to/platform/specific/file</path>
            <platform>osx-x86_64</platform>
          </artifact>
        </artifacts>

        <!--
          Defines a list of additional files as globs.
          These files will be added to the assembled archive.
          
        -->
        <files>
          <file>
            <!--
              The pattern to use.
              May use glob or regex pattern syntax.
               
            -->
            <pattern>path/to/**/*.txt</pattern>
          </file>
        </files>

        <!--
          Defines a list of additional files as filesets.
          These files will be added to the assembled archive.
          
        -->
        <fileSets>
          <fileSet>
            <!--
              The input directory to copy files from.
               
            -->
            <input>path/to/input/directory</input>

            <!--
              The target path inside the archive.
              If left undefined, defaults to the root of the archive.
               
            -->
            <output>path/to/archive/entry</output>

            <!--
              Fail if the given `input` does not exist.
              Defaults to `true`.
              
            -->
            <failOnMissingInput>false</failOnMissingInput>

            <!--
              A set of files and directory to include.
               
            -->
            <includes>
              <include>name_or_regex</include>
            </includes>

            <!--
              A set of files and directory to exclude.
               
            -->
            <excludes>
              <exclude>name_or_regex</exclude>
            </excludes>

            <!--
              Additional properties used when evaluating templates.
              
            -->
            <extraProperties>
              <!--
                Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
              -->
              <foo>bar</foo>
            </extraProperties>
          </fileSet>
        </fileSets>

        <!--
          
        -->
        <swid>
          <!--
            Tags require a name.
            
          -->
          <mytag>

            <!--
              Enables or disables the tag.
              Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
              Defaults to `NEVER`.
               
            -->
            <active>ALWAYS</active>

            <!--
              Reference to a common tag.
              
            -->
            <tagRef>swid-tag</tagRef>

            <!--
              Path where the tag file will be placed.
              Defaults to `SWIDTAG`.
              
            -->
            <path>SWID</path>

            <!--
              A globally unique identifier and should be assigned a GUID reference.
              Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
              
            -->
            <tagId>c526ec37-2715-328e-8bbc-4eb5a9f47c98</tagId>

            <!--
              Indicates if a specific release of a software product has more than one tag that can represent that specific release.
              Defaults to `1`.
              
            -->
            <tagVersion>2</tagVersion>

            <!--
              Language used in the tag document.
              Defaults to `en-US`.
              
            -->
            <lang>de</lang>

            <!--
              If this SWID tag is a collection of information that describes the pre-installation data of software component.
              Defaults to `false`.
              
            -->
            <corpus>true</corpus>

            <!--
              If this SWID tag describes a product patch or modification to a different software element.
              Defaults to `false`.
              
            -->
            <patch>false</patch>

            <!--
              List of organizations related to the software component referenced by this SWID tag.
              
            -->
            <entities>
              <entity>
                <!--
                  name of the organization claiming a particular role in the SWID tag.
                  
                -->
                <name>Acme</name>

                <!--
                  URI of the claiming organization.
                  Defaults to `http://invalid.unavailable`.
                  
                -->
                <regid>https://acme.com</regid>

                <!--
                  The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
                  The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
                  include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
                  Other roles will be defined as the market uses the SWID tags.
                  Defaults to [`tagCreator`, `softwareCreator`].
                  
                -->
                <roles>
                  <role>tagCreator</role>
                  <role>softwareCreator</role>
                </roles>
              </entity>
            </entities>
          </swid-tag>
        </swid>
      </app>
    </nativeImage>
  </assemble>
</jreleaser>
jreleaser {
  // 
  assemble {
    // 
    nativeImage {
      // Assemblers require a name.
      // 
      app {

        // Enables or disables the assembler.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        //  
        active = 'ALWAYS'

        // Export the assembled artifacts as a matching named distribution.
        // Defaults to `true`.
        // 
        exported = true

        // The stereotype of this assembler.
        // Supported values are [`NONE`, `CLI`, `DESKTOP`, `WEB`, `MOBILE`].
        // Defaults to `#{project.stereotype}`.
        // 
        stereotype = 'CLI'

        // Additional properties used when evaluating templates.
        // Key will be capitalized and prefixed with `nativeImage`, i.e, `nativeImageFoo`.
        //  
        extraProperties.put('foo', 'bar')

        // 
        platform {

          // Key value pairs.
          // Keys match a full platform or an os.name, os.arch.
          // Same rules apply as in Platform.
          // 
          replacements = [
            'osx-x86_64': 'mac',
            aarch_64: 'aarch64',
            x86_64: 'amd64',
            linux_musl: 'alpine'
          ]
        }

        // Name of the executable launcher.
        // If left undefined, will use `#{assembler.name}`.
        // 
        executable = 'app'

        // Name of the generated image.
        // If left undefined, will use
        // `#{assembler.executable}-#{project.version}`.
        // Generated artifacts always have the platform as suffix.
        //  
        imageName = 'app-{{projectVersion}}'

        // Name transformation of the generated image.
        // Transformed artifacts always have the platform as suffix.
        //  
        imageNameTransform = 'app-{{projectEffectiveVersion}}'

        // 
        archiving {
          // If set to `true`, generates an archive and assembles a BINARY distribution.
          // If set to `false`, does *not* generate an archive and assembles a FLAT_BINARY distribution.
          // Defaults to `true`.
          enabled = true

          // Archive format to use.
          // Supported values are [`ZIP`, `TAR`, `TAR_BZ2`, `TAR_GZ`, `TAR_XZ`, `TBZ2`, `TGZ`, `TXZ`].
          // Defaults to `ZIP`.
          // 
          format = 'TGZ'
        }

        // Includes the default matrix.
        // 
        applyDefaultMatrix = false

        // Configures matrix variables.
        // 
        matrix {
          variable('os', ['linux', 'osx', 'windows'])
          variable('arch', ['arm64', 'amd64'])

          row(os: 'linux', arch: 'arm64')
          row(os: 'linux', arch: 'amd64')
          row(os: 'osx', arch: 'arm64')
          row(os: 'osx', arch: 'amd64')
          row(os: 'windows', arch: 'arm64')
          row(os: 'windows', arch: 'amd64')
        }

        // Define a pattern for parameterizable graalJdks
        //  
        graalJdkPattern {
          path = 'path/to/jdk'
        }

        // List of Graal JDKs.
        //  
        graalJdk {
          path = 'path/to/jdk'
          platform = 'osx-x86_64'
        }
        graalJdk {
          path = 'path/to/jdk'
          platform = 'linux-x86_64'
        }

        // A list of build arguments.
        // The `-H =Name` argument will always be replaced with the
        // value of $executable.
        // 
        arg('--install-exit-handlers')

        // A list of additional GraalVM components to be installed.
        // 
        component('espresso')

        // Compress the resulting executable with UPX.
        // 
        upx {
          // Enables or disables UPX.
          // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          // Defaults to `NEVER`.
          // 
          active = 'ALWAYS'

          // Tool version.
          // 
          version = '3.96'

          // A list of arguments.
          // 
          arg('-f')
        }

        // 
        linuxX86 {
          // A list of arguments.
          // 
          arg('--static')
        }

        // 
        windowsX86 {
          // A list of arguments.
          // 
          arg('--foo')
        }

        // 
        macosX86 {
          // A list of arguments.
          // 
          arg('--bar')
        }

        // 
        linuxArm {
          // A list of arguments.
          // 
          arg('--static')
        }

        // 
        macosArm {
          // A list of arguments.
          // 
          arg('--bar')
        }

        // 
        options {
          // Timestamp to use for each entry.
          // Must follow ISO-8601 + timezone offset.
          // Example: 2023-03-08T12:56:33.024578+01:00
          // Defaults to timestamp for latest git commit or current time.
          // 
          timestamp = '2020-01-01T00:00:00.000000+00:00'

          // Set longFileMode for tar archives.
          // Possible values are [`ERROR`, `GNU`, `POSIX`, `TRUNCATE`].
          // Defaults to `ERROR`.
          // 
          longFileMode = 'POSIX'

          // Set bigNumberMode for tar archives.
          // Possible values are [`ERROR`, `GNU`, `POSIX`].
          // Defaults to `ERROR`.
          // 
          bigNumberMode = 'POSIX'
        }

        // The executable JAR that contains the application.
        //  
        mainJar {
          path = 'path/to/app.jar'
        }

        // Defines a list of additional JARs as globs.
        // 
        jars {
          // The pattern to use.
          // May use glob or regex pattern syntax.
          //  
          pattern = 'path/to/**/*.jar'
        }

        // 
        java {
          // Name of main module (if any).
          // Define only if the application is modular.
          // 
          mainModule = 'com.acme.demo'

          // The application's entry point.
          // If left undefined, will use `#{project.java.mainClass}`.
          // 
          mainClass = 'com.acme.Main'

          // Options to pass to the Java runtime
          // 
          jvmOptions {
            // Included in all scripts
            //  
            universal('-Dprop=value')
            // Included in all non Windows scripts
            //  
            unix('-Dprop=value')
            // Included in all non Windows (except OSX) scripts
            //  
            linux('-Dprop=value')
            // Included only in OSX scripts
            //  
            osx('-Dprop=value')
            // Included in Windows scripts
            //  
            windows('-Dprop=value')
          }

          // Environment variables used in launch scripts.
          // 
          environmentVariables {
            // Included in all scripts
            //  
            universal('KEY', 'value')
            // Included in all non Windows scripts
            //  
            unix('KEY', 'value')
            // Included in all non Windows (except OSX) scripts
            //  
            linux('KEY', 'value')
            // Included only in OSX scripts
            //  
            osx('KEY', 'value')
            // Included in Windows scripts
            //  
            windows('KEY', 'value')
          }

          // Maven coordinates = groupId.
          // If left undefined, will use `#{project.java.groupId}`.
          // 
          groupId = 'com.acme'

          // Maven coordinates = artifactId.
          // If left undefined, will use `#{project.java.artifactId}`.
          // 
          artifactId = 'app'

          // The minimum Java version required by consumers to run the application.
          // If left undefined, will use `#{project.java.version}`.
          // 
          version = '8'

          // Identifies the project as being member of a multi-project build.
          // If left undefined, will use `#{project.java.multiProject}`.
          // 
          multiProject = false

          // Additional properties used when evaluating templates.
          // Key will be capitalized and prefixed with `java`, i.e, `javaFoo`.
          // 
          extraProperties.put('foo', 'bar')
        }

        // Directory with file templates used to prepare the assembler.
        // Defaults to `src/jreleaser/assemblers/#{distribution.name}/nativeImage`.
        // If specified, path must exist.
        // 
        templateDirectory = 'path/to/nativeImage/templates'

        // List of template files to be skipped.
        // Value may be an exact match or a regex.
        // 
        skipTemplate('README.md.tpl')

        // Defines a list of additional files as artifacts.
        // These files will be added to the assembled archive.
        //  
        artifact {
          path = 'path/to/file'
        }
        artifact {
          path = 'path/to/another_file'
          transform = 'path/inside/archive'
        }
        artifact {
          path = 'path/to/platform/specific/file'
          platform = 'osx-x86_64'
        }

        // Defines a list of additional files as globs.
        // These files will be added to the assembled archive.
        // 
        files {
          // The pattern to use.
          // May use glob or regex pattern syntax.
          //  
          pattern = 'path/to/**/*.txt'
        }

        // Defines a list of additional files as filesets.
        // These files will be added to the assembled archive.
        // 
        fileSet {
          // The input directory to copy files from.
          //  
          input = 'path/to/input/directory'

          // The target path inside the archive.
          // If left undefined, defaults to the root of the archive.
          //  
          output = 'path/to/archive/entry'

          // Fail if the given `input` does not exist.
          // Defaults to `true`.
          // 
          failOnMissingInput = false

          // A set of files and directory to include.
          //  
          includes = ['name_or_regex']

          // A set of files and directory to exclude.
          //  
          excludes = ['name_or_regex']

          // Additional properties used when evaluating templates.
          // Key will be capitalized and prefixed with `artifact`, i.e, `artifactFoo`.
          //  
          extraProperties.put('foo', 'bar')
        }

        // 
        swid {
          // Tags require a name.
          // 
          mytag {

            // Enables or disables the tag.
            // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
            // Defaults to `NEVER`.
            //  
            active = 'ALWAYS'

            // Reference to a common tag.
            // 
            tagRef = 'swid-tag'

            // Path where the tag file will be placed.
            // Defaults to `SWIDTAG`.
            // 
            path = 'SWID'

            // A globally unique identifier and should be assigned a GUID reference.
            // Defaults to a UUID generated with `groupId`, `artifactId`, `version`, `vendor`.
            // 
            tagId = 'c526ec37-2715-328e-8bbc-4eb5a9f47c98'

            // Indicates if a specific release of a software product has more than one tag that can represent that specific release.
            // Defaults to `1`.
            // 
            tagVersion = 2

            // Language used in the tag document.
            // Defaults to `en-US`.
            // 
            lang = 'de'

            // If this SWID tag is a collection of information that describes the pre-installation data of software component.
            // Defaults to `false`.
            // 
            corpus = true

            // If this SWID tag describes a product patch or modification to a different software element.
            // Defaults to `false`.
            // 
            patch = false

            // List of organizations related to the software component referenced by this SWID tag.
            // 
            entity {
              // name of the organization claiming a particular role in the SWID tag.
              // 
              name = 'Acme'

              // URI of the claiming organization.
              // Defaults to `http://invalid.unavailable`.
              // 
              regid = 'https://acme.com'

              // The relationship between this organization and this tag e.g. tag, `softwareCreator`, `licensor`, `tagCreator`, etc.
              // The role of `tagCreator` is required for every SWID tag. May include any role value, but the pre-defined roles
              // include: `aggregator`, `distributor`, `licensor`, `softwareCreator`, `tagCreator`.
              // Other roles will be defined as the market uses the SWID tags.
              // Defaults to [`tagCreator`, `softwareCreator`].
              // 
              role('tagCreator')
              role('softwareCreator')
            }
          }
        }
      }
    }
  }
}

Environment

When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.

System Property Environment Variable

active

jreleaser.assemble.native.image.${name}.active
jreleaser.assemble.native.image.active

JRELEASER_ASSEMBLE_NATIVE_IMAGE_${name}_ACTIVE
JRELEASER_ASSEMBLE_NATIVE_IMAGE_ACTIVE
Substitute ${name} for the value of the named instance.

Space (' '), underscore (_), and dash (-) will be replaced by dot (.) to separate tokens in the System property. Space (' '), dash (-), and dot (.) will be replaced by underscore (_) to separate tokens in the environment variable, such that:

${name} System Property Environment Variable

foobar

foobar

FOOBAR

fooBar

foobar

FOOBAR

foo bar

foo.bar

FOO_BAR

foo-bar

foo.bar

FOO_BAR

foo_bar

foo.bar

FOO_BAR

foo.bar

foo.bar

FOO_BAR

Matrix

Parameterize graalJdk resolution with a set of key/value pairs. For example the following definitions are equivalent

With matrix
assemble:
  nativeImage:
    helloworld:
      active: ALWAYS
      imageName: '{{distributionName}}-{{projectEffectiveVersion}}'
      matrix:
        rows:
          - { platform: osx-aarch_64,   suffix: OsxArm,       dir: '/Contents/Home' }
          - { platform: osx-x86_64,     suffix: OsxIntel,     dir: '/Contents/Home' }
          - { platform: linux-x86_64,   suffix: LinuxIntel,   dir: '' }
          - { platform: windows-x86_64, suffix: WindowsIntel, dir: '' }
      graalJdkPattern:
        path: '{{jdkPathPrefix}}/graalvm22{{matrix.suffix}}/{{graalFilePrefix}}{{matrix.dir}}'
      mainJar:
        path: 'target/{{distributionName}}-{{projectVersion}}.jar'
Without matrix
assemble:
  nativeImage:
    helloworld:
      active: ALWAYS
      imageName: '{{distributionName}}-{{projectEffectiveVersion}}'
      mainJar:
        path: 'target/{{distributionName}}-{{projectVersion}}.jar'
      graalJdks:
        - path: '{{jdkPathPrefix}}/graalvm22OsxIntel/{{graalFilePrefix}}/Contents/Home'
          platform: 'osx-x86_64'
        - path: '{{jdkPathPrefix}}/graalvm22OsxArm/{{graalFilePrefix}}/Contents/Home'
          platform: 'osx-aarch_64'
        - path: '{{jdkPathPrefix}}/graalvm22LinuxIntel/{{graalFilePrefix}}'
          platform: 'linux-x86_64'
        - path: '{{jdkPathPrefix}}/graalvm22WindowsIntel/{{graalFilePrefix}}'
          platform: 'windows-x86_64'

Special keys

The following keys have special meaning:

platform

Sets the platform for a matching JDK.

Graal JDKs

The following rules apply when resolving which Graal JDK will be used to generate native image executables:

  1. A matching JDK (by platform) will be searched in graalJdks.

  2. If no match is found then the currently executing JDK will be used.

Paths for graalJdks must exist in the file system. You may use the maven jdks-maven-plugin or gradle jdks-gradle-plugin to download required JDKs.

UPX

Executables may optionally be compressed with UPX. You must define a version. JReleaser will check if a matching binary exists in the system or download a binary that matches the current platform.

Templates

The default location for templates is:

src/jreleaser/assemblers/<distribution-name>/nativeImage

Any additional files found in the template directories will be copied as is unless their filename ends with .tpl in which case Name Templates substitution will take place.

Skip Templates

You may skip any template files by defining a set of skip rules in the skipTemplates property. For example, you may use any of these expressions to skip a template named README.md.tpl:

  • README.md.tpl: matches the full template name

  • README.md: matches the transformed template name

  • README.*: matches using a regex

Additional Files

There are several ways to define additional files that may be handled by this assembler.

Templates

  • You may use Name Templates inside the files to be copied.

  • They retain directory structure that is, a template found at {templateDirectory}/foo.txt.tpl will be copied as foo.txt while a template such as {templateDirectory}/docs/bar.md.tpl will be copied to docs/bar.md.

FileSets

  • May use globs or regexes to define files to be included from a starting directory.

  • They retain directory structure.

  • May rename the target parent directory.

Files

  • May use globs or regexes to define files to be included from a starting directory.

  • They do not retain directory structure. Only filenames are copied.

Artifacts

  • They do not retain directory structure by default. An artifact with path set to bin/launcher.sh will be copied to launcher.sh.

  • May use the transform property to define the target path. An artifact with path set to bin/launcher.sh and transform set to bin/{{projectName}} will be copied to bin/app [assuming projectName resolves to app].

  • May use the platform property to filter files per matching platform. An artifact with platform set to windows-x86_64 will only be copied when the matching platform is compatible with windows-x86_64.

  • Artifacts without an explicit platform won’t be filtered.