Field Detail

• ROLE

  static final String ROLE

  The Plexus role.

Method Detail

• execute

  ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      ReleaseEnvironment releaseEnvironment,
                      List<MavenProject> reactorProjects)
                        throws ReleaseExecutionException,
                               ReleaseFailureException

  Execute the phase.

  Parameters:

  releaseDescriptor - the configuration to use

  releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.

  reactorProjects - the reactor projects

  Returns:

  the release result

  Throws:

  ReleaseExecutionException - an exception during the execution of the phase

  ReleaseFailureException - a failure during the execution of the phase

• simulate

  ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                       ReleaseEnvironment releaseEnvironment,
                       List<MavenProject> reactorProjects)
                         throws ReleaseExecutionException,
                                ReleaseFailureException

  Simulate the phase, but don't make any changes to the project.

  Parameters:

  releaseDescriptor - the configuration to use

  releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.

  reactorProjects - the reactor projects

  Returns:

  the release result

  Throws:

  ReleaseExecutionException - an exception during the execution of the phase

  ReleaseFailureException - a failure during the execution of the phase

• execute

  ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      Settings settings,
                      List<MavenProject> reactorProjects)
                        throws ReleaseExecutionException,
                               ReleaseFailureException

  Deprecated. Use execute(ReleaseDescriptor, ReleaseEnvironment, List) instead.
  Execute the phase.

  Parameters:

  releaseDescriptor - the configuration to use

  settings - the settings.xml configuration

  reactorProjects - the reactor projects

  Returns:

  the release result

  Throws:

  ReleaseExecutionException - an exception during the execution of the phase

  ReleaseFailureException - a failure during the execution of the phase

• simulate

  ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                       Settings settings,
                       List<MavenProject> reactorProjects)
                         throws ReleaseExecutionException,
                                ReleaseFailureException

  Deprecated. Use simulate(ReleaseDescriptor, ReleaseEnvironment, List) instead.
  Simulate the phase, but don't make any changes to the project.

  Parameters:

  releaseDescriptor - the configuration to use

  settings - the settings.xml configuration

  reactorProjects - the reactor projects

  Returns:

  the release result

  Throws:

  ReleaseExecutionException - an exception during the execution of the phase

  ReleaseFailureException - a failure during the execution of the phase

• clean

  ReleaseResult clean(List<MavenProject> reactorProjects)

  Clean up after a phase if it leaves any additional files in the checkout.

  Parameters:

  reactorProjects - the reactor projects

  Returns:

  the release result