Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
tentackle-i18n:cleanup Removes obsolete bundles and keys.
Does nothing if there are errors or warnings to make sure that there are no pending refactorings to be resolved by the BundleMonkey tool. Consider running verify first to check for such warnings.
tentackle-i18n:help Display help information on tentackle-i18n-maven-plugin.
Call mvn tentackle-i18n:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
tentackle-i18n:pull Pulls resource bundles from the database backend.
If the database contents differ from the resource bundle property files, the property files will be updated.
tentackle-i18n:push Pushes resource bundles to the database backend.
Existing translations are left unchanged.
tentackle-i18n:verify Verifies the bundles stored in the backend against the property resource bundles of the application.
The mojo fails if missing translations in the database would raise a java.util.MissingResourceException.
Notice: the application's resource bundles are verified via the tentackle-check-maven-plugin during the build process.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.0
JDK 21

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 21.15.0.0 to 21.16.1.0 - 21
from 17.8.0.0 to 17.14.0.2 - 17
16.0-M1 - 16
from 11.2.3.0 to 11.7.4.1 - 11
from 8.2.2.0 to 8.3.0.4 - 8
2.2.0 - 11
from 2.1.0 to 2.1.6 - 8

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.tentackle</groupId>
          <artifactId>tentackle-i18n-maven-plugin</artifactId>
          <version>21.16.1.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.tentackle</groupId>
        <artifactId>tentackle-i18n-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"