com.atlassian.maven.plugins.jgitflow.mojo.ReleaseStartMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgitflow-maven-plugin Show documentation
A maven plugin to support doing git-flow releases
The newest version!
package com.atlassian.maven.plugins.jgitflow.mojo;

/*-
 * #%L
 * JGitFlow :: Maven Plugin
 * %%
 * Copyright (C) 2017 Atlassian Pty, LTD, Ultreia.io
 * %%
 * Licensed 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.
 * #L%
 */

import com.atlassian.maven.jgitflow.api.MavenReleaseStartExtension;
import com.atlassian.maven.plugins.jgitflow.ReleaseContext;
import com.atlassian.maven.plugins.jgitflow.exception.MavenJGitFlowException;
import com.atlassian.maven.plugins.jgitflow.manager.FlowReleaseManager;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;

/**
 * @since version
 */
@Mojo(name = "release-start", aggregator = true, requiresDependencyResolution = ResolutionScope.TEST)
public class ReleaseStartMojo extends AbstractJGitFlowMojo
{

    /**
     * Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the
     * version of each submodules.
     */
    @Parameter(defaultValue = "false", property = "autoVersionSubmodules")
    private boolean autoVersionSubmodules = false;

    /**
     * Default version to use when preparing a release
     */
    @Parameter(property = "releaseVersion", defaultValue = "")
    private String releaseVersion = "";

    /**
     * Default version to use for new local working copy.
     */
    @Parameter(property = "developmentVersion", defaultValue = "")
    private String developmentVersion = "";

    /**
     * Version number to increment - 0=Major, 1=Minor, 2=Minor/Patch (Depending on version pattern).
     */
    @Parameter(property = "versionNumberToIncrement", defaultValue = "2")
    private String versionNumberToIncrement = "2";

    /**
     * Increment the new develop branch version number based off of the release version.
     */
    @Parameter(defaultValue = "false", property = "incrementDevelopFromReleaseVersion")
    private boolean incrementDevelopFromReleaseVersion = false;

     /**
      * Suffix to append to versions on the release branch.
      */
    @Parameter(property = "releaseBranchVersionSuffix", defaultValue = "")
    private String releaseBranchVersionSuffix = "";

    /**
     * Whether, for modules which refer to each other within the same multi-module build, to update dependencies version to the release version.
     */
    @Parameter(defaultValue = "true", property = "updateDependencies")
    private boolean updateDependencies = true;

    /**
     * Whether to push release branches to the remote upstream.
     */
    @Parameter(defaultValue = "false", property = "pushReleases")
    private boolean pushReleases = false;

    @Component(hint = "release")
    FlowReleaseManager releaseManager;

    /**
     * A SHA, short SHA, or branch name to use as the starting point for the new branch
     */
    @Parameter(property = "startCommit", defaultValue = "")
    private String startCommit = "";

    /**
     * A FQCN of a compatible release start extension.
     * Extensions are used to run custom code at various points in the jgitflow lifecycle.
     * 
     * More documentation on using extensions will be available in the future
     */
    @Parameter(defaultValue = "")
    private String releaseStartExtension = "";

    /**
     * Whether to add -SNAPSHOT to the new version in the release branch
     */
    @Parameter(defaultValue = "true", property = "releaseSnapshots")
    private boolean releaseSnapshots = true;

    /**
     * If set to true, skip pre-commit and message hooks when committing.
     */
    @Parameter(defaultValue = "false", property = "noVerifyRelease")
    protected boolean noVerifyRelease = false;

    /**
     * If set to true, add fix level 0 to relase version.
     */
    @Parameter(defaultValue = "false", property = "addFixLevel")
    protected boolean addFixLevel = false;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException
    {
        ClassLoader oldClassloader = Thread.currentThread().getContextClassLoader();

        Thread.currentThread().setContextClassLoader(getClassloader(getClasspath()));

        MavenReleaseStartExtension extensionObject = (MavenReleaseStartExtension) getExtensionInstance(releaseStartExtension);

        ReleaseContext ctx = new ReleaseContext(getBasedir());
        ctx.setAutoVersionSubmodules(autoVersionSubmodules)
           .setInteractive(getSettings().isInteractiveMode())
           .setDefaultReleaseVersion(releaseVersion)
           .setDefaultDevelopmentVersion(developmentVersion)
           .setVersionNumberToIncrement(versionNumberToIncrement)
           .setIncrementDevelopFromReleaseVersion(incrementDevelopFromReleaseVersion)
           .setReleaseBranchVersionSuffix(releaseBranchVersionSuffix)
           .setAllowSnapshots(allowSnapshots)
           .setUpdateDependencies(updateDependencies)
           .setEnableSshAgent(enableSshAgent)
           .setAllowUntracked(allowUntracked)
           .setPushReleases(pushReleases)
           .setStartCommit(startCommit)
           .setAllowRemote(isRemoteAllowed())
           .setDefaultOriginUrl(defaultOriginUrl)
           .setAlwaysUpdateOrigin(alwaysUpdateOrigin)
           .setPullMaster(pullMaster)
           .setPullDevelop(pullDevelop)
           .setScmCommentPrefix(scmCommentPrefix)
           .setScmCommentSuffix(scmCommentSuffix)
           .setUsername(username)
           .setPassword(password)
           .setReleaseStartExtension(extensionObject)
           .setEol(eol)
           .setReleaseSnapshots(releaseSnapshots) 
           .setFlowInitContext(getFlowInitContext().getJGitFlowContext())
           .setNoVerify(noVerifyRelease)
           .setAddFixLevel(addFixLevel);

        try
        {
            releaseManager.start(ctx, getReactorProjects(), session);
        }
        catch (MavenJGitFlowException e)
        {
            throw new MojoExecutionException("Error starting release: " + e.getMessage(), e);
        }
        finally
        {
            Thread.currentThread().setContextClassLoader(oldClassloader);
        }
    }
}