Fork me on GitHub

jinja:generate

Full name:

com.github.chitralverma:jinja-maven-plugin:1.0-SNAPSHOT:generate

Description:

GenerateFromJinjaTemplateMojo

This mojo automatically renders concrete resources from Jinja template files as part of Maven build process.

Users define template file(s) and corresponding value file(s). When the plugin executes, it substitutes the values from value file(s) in the template file(s) and renders concrete resource(s) at the configured location.

This plugin uses jinjava, see this link for more info.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
<resourceSet> List - Configuration for resource set. A resource set is bundle of one or more resources which can be translated to a rendering job. Each resource contains a template file path, one or more value files and an output file path.

Optional Parameters

Name Type Since Description
<failOnMissingValues> Boolean - Configuration to fail if values for template are missing. Default: true
Default value is: true.
User property is: jinja-maven.failOnMissingValues.
<overwriteOutput> Boolean - Configuration to control if output files can be overwritten. Default: false
Default value is: false.
User property is: jinja-maven.overwriteOutput.
<skip> Boolean - Configuration to skip the entire goal. Default: false
Default value is: false.
User property is: jinja-maven.skip.

Parameter Details

<failOnMissingValues>

Configuration to fail if values for template are missing. Default: true
  • Type: java.lang.Boolean
  • Required: No
  • User Property: jinja-maven.failOnMissingValues
  • Default: true

<overwriteOutput>

Configuration to control if output files can be overwritten. Default: false
  • Type: java.lang.Boolean
  • Required: No
  • User Property: jinja-maven.overwriteOutput
  • Default: false

<resourceSet>

Configuration for resource set. A resource set is bundle of one or more resources which can be translated to a rendering job. Each resource contains a template file path, one or more value files and an output file path.
  • Type: java.util.List
  • Required: Yes

<skip>

Configuration to skip the entire goal. Default: false
  • Type: java.lang.Boolean
  • Required: No
  • User Property: jinja-maven.skip
  • Default: false