Template Basics

Once size does not fit all as no two build are setup identically. JReleaser recognizes this and lets you customize every single aspect of the release process, by means of parameterizable configuration settings and file templates.

Many fields found in the Configuration options can be parameterized using Mustache templates. Basically you write down text as you’d normally do and use the {{placeholder}} syntax in places where you’d want to have a value placeholder be replace by the actual value as computed/exposed by JReleaser.

There are several predefined Name Templates that can be used as placeholders in configuration field names. You may also use these placeholders in template files, such as those that may be used by the Mail announcer, or the Homebrew packager.

JReleaser provides built-in file templates for all packagers which will be automatically selected when preparing files for a particular packager. You may override this behavior by providing your own templates, either at the default location expected by each packager, or by pointing the packager to a different template source.

Template files may be generated using the appropriate command exposed by your tool of choice: CLI, Maven, Gradle, Ant.

Some configuration elements let you define custom properties that may be used as placeholders, for example

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

project:
  extraProperties:
    foo: bar
[project]
  extraProperties.foo = "bar"
{
  "project": {
    "extraProperties": {
      "foo": "bar"
    }
  }
}
<jreleaser>
  <project>
    <extraProperties>
      <foo>bar</foo>
    </extraProperties>
  </project>
</jreleaser>
jreleaser {
  project {
    extraProperties.put('foo', 'bar')
  }
}

These extra properties will always be prefixed by their containing element, in this case project, thus the foo resolves to projectFoo and can be consumed as {{projectFoo}} from any template.

A property name may use the special _split suffix in which case it’s assumed that the value is a literal that should be treated as a collection. The last character in the value is used as the separator.

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

project:
  extraProperties:
    foo_split: '1,2,3,4,5,'
[project]
  extraProperties.foo_split = "1,2,3,4,5,"
{
  "project": {
    "extraProperties": {
      "foo_split": "1,2,3,4,5,"
    }
  }
}
<jreleaser>
  <project>
    <extraProperties>
      <foo_split>1,2,3,4,5,</foo_split>
    </extraProperties>
  </project>
</jreleaser>
jreleaser {
  project {
    extraProperties.put('foo_split', '1,2,3,4,5,')
  }
}

Given this input and the following template:

{{projectFoo}}

{{#projectFoo}}
{{.}}
{{/projectFoo}}

Then the resulting evalution will be

[1, 2, 3, 4, 5]

1
2
3
4
5