lifecycle-helper:execution-plan-file

Full name:

it.serendigity.maven.plugins:lifecycle-helper-maven-plugin:1.2.2:execution-plan-file

Description:

List execution plan for the current project to an output file.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
<paramFileFormat> ExecutionPlanFileMojo$FILE_FORMAT - No description.
Default: CSV
User Property: lifecycle-helper.fileFormat
<paramFilterPlugins> String[] - Allows you to filter the specified plugins (plugin-artifact-id).
User Property: lifecycle-helper.filter.plugins
<paramForceTasksFromSession> boolean - If enabled the tasks are taken from maven session and the property paramLifecycleTasks is ignored Helpful when you include the plugin in your pom in order to list the execution-plan of the current tasks build.
Default: false
User Property: lifecycle-helper.forceTasksFromSession
<paramLifecycleTasks> String[] - Allows you to specify which tasks (lifecycle phases or plugin/goal) will be used to calculate the execution plan. If not specified the run tasks are the phases: post-clean, deploy, site-deploy. If you set paramForceTasksFromSession to true this parameter is ignored!
Default: post-clean,deploy,site-deploy
User Property: lifecycle-helper.tasks
<paramOutputDirectory> File - Output directory to write the execution plan. The default is the project's build directory. For goals that don't require a project the current directory will be used.
Default: ${project.build.directory}
User Property: lifecycle-helper.outputDirectory
<paramOutputFileName> String - The name of the execution plan file. A file extension matching the configured fileFormat will be added if not specified.
Default: lifecycle-helper
User Property: lifecycle-helper.outputFileName
<paramSkip> boolean 0.4.0 Skip the execution.
Default: false
User Property: lifecycle-helper.skip

Parameter Details

<paramFileFormat>

No description.
  • Type: it.serendigity.maven.plugin.lifecycle.helper.ExecutionPlanFileMojo$FILE_FORMAT
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.fileFormat
  • Default: CSV

<paramFilterPlugins>

Allows you to filter the specified plugins (plugin-artifact-id).
  • Type: java.lang.String[]
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.filter.plugins

<paramForceTasksFromSession>

If enabled the tasks are taken from maven session and the property paramLifecycleTasks is ignored Helpful when you include the plugin in your pom in order to list the execution-plan of the current tasks build.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.forceTasksFromSession
  • Default: false

<paramLifecycleTasks>

Allows you to specify which tasks (lifecycle phases or plugin/goal) will be used to calculate the execution plan. If not specified the run tasks are the phases: post-clean, deploy, site-deploy. If you set paramForceTasksFromSession to true this parameter is ignored!
  • Type: java.lang.String[]
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.tasks
  • Default: post-clean,deploy,site-deploy

<paramOutputDirectory>

Output directory to write the execution plan. The default is the project's build directory. For goals that don't require a project the current directory will be used.
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.outputDirectory
  • Default: ${project.build.directory}

<paramOutputFileName>

The name of the execution plan file. A file extension matching the configured fileFormat will be added if not specified.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.outputFileName
  • Default: lifecycle-helper

<paramSkip>

Skip the execution.
  • Type: boolean
  • Since: 0.4.0
  • Required: report.plugin.goal.no
  • User Property: lifecycle-helper.skip
  • Default: false