package org.apache.maven.plugins.release;

 /*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *  http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 import java.util.Arrays;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.plugin.MojoFailureException;

 import org.apache.maven.shared.release.ReleaseExecutionException;

 import org.apache.maven.shared.release.ReleaseFailureException;

 import org.apache.maven.shared.release.config.ReleaseDescriptor;

 import org.apache.maven.shared.release.config.ReleaseUtils;

 /**

  * Branch a project in SCM, using the same steps as the <tt>release:prepare</tt> goal, creating a branch instead of a tag.

  * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/branch.html">http://maven.apache.org/plugins/maven-release-plugin/examples/branch.html</a>.

  *

  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>

  * @version $Id: BranchReleaseMojo.java 1329473 2012-04-23 21:58:55Z rfscholte $

  * @aggregator

  * @goal branch

  * @since 2.0-beta-6

  */

 public class BranchReleaseMojo

     extends AbstractReleaseMojo

 {

     /**

      * The branch name to use.

      *

      * @parameter expression="${branchName}"

      * @required

      * @since 2.0-beta-6

      */

     private String branchName;

     /**

      * The branch base directory in SVN, you must define it if you don't use the standard svn layout (trunk/tags/branches).

      * For example, <code>http://svn.apache.org/repos/asf/maven/plugins/branches</code>. The URL is an SVN URL and does not

      * include the SCM provider and protocol.

      *

      * @parameter expression="${branchBase}"

      * @since 2.0

      */

     private String branchBase;

     /**

      * Whether to update versions in the branch.

      *

      * @parameter expression="${updateBranchVersions}" default-value="false"

      * @since 2.0-beta-6

      */

     private boolean updateBranchVersions;

     /**

      * Whether to update versions in the working copy.

      *

      * @parameter expression="${updateWorkingCopyVersions}" default-value="true"

      * @since 2.0-beta-6

      */

     private boolean updateWorkingCopyVersions;

     /**

      * Whether to suppress a commit of changes to the working copy

      * before the tag is created.

      * <br/>

      * <br/>This requires <code>remoteTagging</code> to be set to false.

      * <br/>

      * <br/><code>suppressCommitBeforeBranch</code> is useful when you want

      * to avoid poms with released versions in all revisions of your

      * trunk or development branch.

      *

      * @parameter expression="${suppressCommitBeforeBranch}" default-value="false"

      * @since 2.1

      */

     private boolean suppressCommitBeforeBranch;

     /**

      * Whether to update versions to SNAPSHOT in the branch.

      *

      * @parameter expression="${updateVersionsToSnapshot}" default-value="true"

      * @since 2.0-beta-6

      */

     private boolean updateVersionsToSnapshot;

     /**

      * Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.

      *

      * @parameter expression="${useEditMode}" default-value="false"

      * @since 2.0-beta-6

      */

     private boolean useEditMode;

     /**

      * Whether to update dependencies version to the next development version.

      *

      * @parameter expression="${updateDependencies}" default-value="true"

      * @since 2.0-beta-6

      */

     private boolean updateDependencies;

     /**

      * Whether to automatically assign submodules the parent version.  If set to false,

      * the user will be prompted for the version of each submodules.

      *

      * @parameter expression="${autoVersionSubmodules}" default-value="false"

      * @since 2.0-beta-6

      */

     private boolean autoVersionSubmodules;

     /**

      * Dry run: don't checkin or tag anything in the scm repository, or modify the checkout.

      * Running <code>mvn -DdryRun=true release:prepare</code> is useful in order to check that modifications to

      * poms and scm operations (only listed on the console) are working as expected.

      * Modified POMs are written alongside the originals without modifying them.

      *

      * @parameter expression="${dryRun}" default-value="false"

      * @since 2.0-beta-6

      */

     private boolean dryRun;

     /**

      * Whether to add a schema to the POM if it was previously missing on release.

      *

      * @parameter expression="${addSchema}" default-value="true"

      * @since 2.0-beta-6

      */

     private boolean addSchema;

     /**

      * currently only implemented with svn scm. Enable a workaround to prevent issue

      * due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406)

      *

      *

      * @parameter expression="${remoteTagging}" default-value="true"

      * @since 2.0

      */

     private boolean remoteTagging;

      /**

      * A list of additional exclude filters that will be skipped when checking for

      * modifications on the working copy.

      *

      * Is ignored, when checkModificationExcludes is set.

      *

      * @parameter

      * @since 2.1

      */

     private String[] checkModificationExcludes;

     /**

      * Command-line version of checkModificationExcludes.

      *

      * @parameter expression="${checkModificationExcludeList}"

      * @since 2.1

      */

     private String checkModificationExcludeList;

     /**

      * Default version to use when preparing a release or a branch.

      *

      * @parameter expression="${releaseVersion}"

      * @since 2.0

      */

     private String releaseVersion;

     /**

      * Default version to use for new local working copy.

      *

      * @parameter expression="${developmentVersion}"

      * @since 2.0

      */

     private String developmentVersion;

     /**

      * {@inheritDoc}

      */

     public void execute()

         throws MojoExecutionException, MojoFailureException

     {

         super.execute();

         ReleaseDescriptor config = createReleaseDescriptor();

         config.setAddSchema( addSchema );

         config.setScmUseEditMode( useEditMode );

         config.setUpdateDependencies( updateDependencies );

         config.setAutoVersionSubmodules( autoVersionSubmodules );

         config.setScmReleaseLabel( branchName );

         config.setScmBranchBase( branchBase );

         config.setBranchCreation( true );

         config.setUpdateBranchVersions( updateBranchVersions );

         config.setUpdateWorkingCopyVersions( updateWorkingCopyVersions );

         config.setUpdateVersionsToSnapshot( updateVersionsToSnapshot );

         config.setRemoteTagging( remoteTagging );

         config.setDefaultReleaseVersion( releaseVersion );

         config.setDefaultDevelopmentVersion( developmentVersion );

         config.setSuppressCommitBeforeTagOrBranch( suppressCommitBeforeBranch );

         // Create a config containing values from the session properties (ie command line properties with cli).

         ReleaseDescriptor sysPropertiesConfig

                 = ReleaseUtils.copyPropertiesToReleaseDescriptor( session.getExecutionProperties() );

         mergeCommandLineConfig( config, sysPropertiesConfig );

         if ( checkModificationExcludeList != null )

         {

             checkModificationExcludes = checkModificationExcludeList.replaceAll( "\\s", "" ).split( "," );

         }

         if ( checkModificationExcludes != null )

         {

             config.setCheckModificationExcludes( Arrays.asList( checkModificationExcludes ) );

         }

         try

         {

             releaseManager.branch( config, getReleaseEnvironment(), getReactorProjects(), dryRun );

         }

         catch ( ReleaseExecutionException e )

         {

             throw new MojoExecutionException( e.getMessage(), e );

         }

         catch ( ReleaseFailureException e )

         {

             throw new MojoFailureException( e.getMessage(), e );

         }

     }

 }