Assemble

Some distribution types may be assembled by JReleaser.

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
assemble:
  # Enable or disable all configured assemblers.
  # Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `ALWAYS`.
  # 
  active: ALWAYS
# 
[assemble]

  # Enable or disable all configured assemblers.
  # Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `ALWAYS`.
  # 
  active = "ALWAYS"
{
  // 
  "assemble": {
    // Enable or disable all configured assemblers.
    // Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    // Defaults to `ALWAYS`.
    // 
    "active": "ALWAYS"
  }
}
<jreleaser>
  <!--
    
  -->
  <assemble>
    <!--
      Enable or disable all configured assemblers.
      Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      Defaults to `ALWAYS`.
      
    -->
    <active>ALWAYS</active>
  </assemble>
</jreleaser>
jreleaser {
  // icon;dot-circle[]
  assemble {
    // Enable or disable all configured assemblers.
    // Valid values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    // Defaults to `ALWAYS`.
    // 
    active = 'ALWAYS'
  }
}
When not explicitly set, the value of active may be resolved from an environment variable JRELEASER_ASSEMBLE_ACTIVE or from a system property jreleaser.assemble.active. The system property takes precedence over the environment variable.

Assemblers will configure a matching distribution by name if it exists and if the assembler exports its artifacts (true by default), otherwise they’ll create a new distribution with their respective name. Assemblers may configure the following distribution properties:

  • active

  • artifacts

  • extraProperties

  • java

  • executable

You may skip resolving outputs for all assemblers or assemblers per type by defining any of the following properties with a true value inside Environment properties or as a property on the command line:

  • skipAssembleResolvers

  • skipArchiveResolver

  • skipJlinkResolver

  • skipJpackageResolver

  • skipNativeImageResolver