wcm.io DevOps

conga:generate

Full name:

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

Description:

Generates configuration using CONGA generator.

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: generate-resources.

Optional Parameters

Name Type Since Description
<allowSymlinks> boolean - Is it allowed to create symlinks instead of copying files if they are local files e.g. from Maven Repository.
Default value is: true.
<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.
<deleteBeforeGenerate> boolean - Delete folders of environments before generating the new files.
Default value is: false.
<environmentDir> File - Source path with environment definitions.
Default value is: ${basedir}/src/main/environments.
<environments> String[] - Selected environments to generate.
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.
<nodes> String[] - Selected nodes to generate.
User property is: conga.nodes.
<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

<versionInfoAdditionalPlugins> String[] - Plugin keys (groupId:artifactId) of additional Maven plugins of the current project's POM to be included in the model export version information.
Default value is: io.wcm.maven.plugins:wcmio-content-package-maven-plugin.

Parameter Details

<allowSymlinks>

Is it allowed to create symlinks instead of copying files if they are local files e.g. from Maven Repository.
  • Type: boolean
  • Required: No
  • Default: true

<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

<deleteBeforeGenerate>

Delete folders of environments before generating the new files.
  • Type: boolean
  • Required: No
  • Default: false

<environmentDir>

Source path with environment definitions.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/environments

<environments>

Selected environments to generate.
  • 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

<nodes>

Selected nodes to generate.
  • Type: java.lang.String[]
  • Required: No
  • User Property: conga.nodes

<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

<versionInfoAdditionalPlugins>

Plugin keys (groupId:artifactId) of additional Maven plugins of the current project's POM to be included in the model export version information.
  • Type: java.lang.String[]
  • Required: No
  • Default: io.wcm.maven.plugins:wcmio-content-package-maven-plugin

Back to top

Copyright ©2015-2023 wcm.io DevOps. All Rights Reserved.

Version: 1.15.1-SNAPSHOT. Last Published: 2023-04-24.