conga:validate | CONGA Maven Plugin

Full name:

io.wcm.devops.conga:conga-maven-plugin:1.15.1-SNAPSHOT:validate

Description:

Validates definitions by trying to parse them with model reader or compile them via handlebars. Validates that the CONGA maven plugin version and CONGA plugin versions match or are newer than those versions used when generating the dependency artifacts.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: compile.
The goal is thread-safe and supports parallel builds.
Binds by default to the lifecycle phase: validate.

Optional Parameters

Name	Type	Since	Description
`<archive>`	`MavenArchiveConfiguration`	`-`	The archive configuration to use. See Maven Archiver Reference.
`<artifactTypeMappings>`	`Map<String,String>`	`-`	Allows to define custom artifact type to extension mappings for resolving dependencies from artifact coordinates where it is not fully clear if the an extension is really the extension or a artifact type identifier. Defaults to `bundle`->`jar`, `content-package`->`zip`.
`<definitionTarget>`	`String`	`-`	Target path for the prepared definition files. Default value is: `${project.build.directory}/definitions`.
`<environmentDir>`	`File`	`-`	Source path with environment definitions. Default value is: `${basedir}/src/main/environments`.
`<environments>`	`String[]`	`-`	Selected environments to validate. User property is: `conga.environments`.
`<modelExportNode>`	`String`	`-`	List for plugins for exporting model data for nodes. You can specify multiple plugins separated by ",". To disable export of model data set to "none". Default value is: `yaml`.
`<pluginConfig>`	`String`	`-`	Plugin-specific configuration. This holds configuration for CONGA plugins that are not part of the built-in set of CONGA plugins (e.g. configuration for the CONGA AEM Plugin). This uses the same syntax as OSGi manifest headers - example: pluginName1;param1=value1;param2=value2, pluginName2;param3=value3
`<roleDir>`	`File`	`-`	Source path with role definitions. Default value is: `${basedir}/src/main/roles`.
`<target>`	`File`	`-`	Target path for the generated configuration files. Default value is: `${project.build.directory}/configuration`.
`<templateDir>`	`File`	`-`	Source path with templates. Default value is: `${basedir}/src/main/templates`.
`<valueProvider>`	`String`	`-`	Configuration for value providers. This uses the same syntax as OSGi manifest headers - example: valueProviderPluginName1;param1=value1;param2=value2, valueProviderPluginName2;param3=value3 If you want to define multiple value providers of the same type, you can use an arbitrary value provider name, and specify the plugin name with the optional `_plugin_` parameter - example: valueProvider1;_plugin_=valueProviderPluginName1,param1=value1;param2=value2, valueProvider2;_plugin_=valueProviderPluginName1,param3=value3

Parameter Details

<archive>

The archive configuration to use. See Maven Archiver Reference.

Type: org.apache.maven.archiver.MavenArchiveConfiguration
Required: No

<artifactTypeMappings>

Allows to define custom artifact type to extension mappings for resolving dependencies from artifact coordinates where it is not fully clear if the an extension is really the extension or a artifact type identifier. Defaults to bundle->jar, content-package->zip.

Type: java.util.Map<java.lang.String, java.lang.String>
Required: No

<definitionTarget>

Target path for the prepared definition files.

Type: java.lang.String
Required: No
Default: ${project.build.directory}/definitions

<environmentDir>

Source path with environment definitions.

Type: java.io.File
Required: No
Default: ${basedir}/src/main/environments

<environments>

Selected environments to validate.

Type: java.lang.String[]
Required: No
User Property: conga.environments

<modelExportNode>

List for plugins for exporting model data for nodes. You can specify multiple plugins separated by ",". To disable export of model data set to "none".

Type: java.lang.String
Required: No
Default: yaml

<pluginConfig>

Plugin-specific configuration. This holds configuration for CONGA plugins that are not part of the built-in set of CONGA plugins (e.g. configuration for the CONGA AEM Plugin).

This uses the same syntax as OSGi manifest headers - example:

pluginName1;param1=value1;param2=value2,
pluginName2;param3=value3

Type: java.lang.String
Required: No

<roleDir>

Source path with role definitions.

Type: java.io.File
Required: No
Default: ${basedir}/src/main/roles

<target>

Target path for the generated configuration files.

Type: java.io.File
Required: No
Default: ${project.build.directory}/configuration

<templateDir>

Source path with templates.

Type: java.io.File
Required: No
Default: ${basedir}/src/main/templates

<valueProvider>

Configuration for value providers.

This uses the same syntax as OSGi manifest headers - example:

valueProviderPluginName1;param1=value1;param2=value2,
valueProviderPluginName2;param3=value3

If you want to define multiple value providers of the same type, you can use an arbitrary value provider name, and specify the plugin name with the optional _plugin_ parameter - example:

valueProvider1;_plugin_=valueProviderPluginName1,param1=value1;param2=value2,
valueProvider2;_plugin_=valueProviderPluginName1,param3=value3

Type: java.lang.String
Required: No