org.apache.maven.plugins.release.BranchReleaseMojo Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.maven.plugins.release;
import java.util.Arrays;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.shared.release.DefaultReleaseManagerListener;
import org.apache.maven.shared.release.ReleaseBranchRequest;
import org.apache.maven.shared.release.ReleaseExecutionException;
import org.apache.maven.shared.release.ReleaseFailureException;
import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
import org.codehaus.plexus.configuration.PlexusConfiguration;
/**
* Branch a project in SCM, using the same steps as the release:prepare goal, creating a branch instead of
* a tag. For more info see https://maven.apache.org/plugins/maven-release-plugin/usage/branch.html.
*
* @author Emmanuel Venisse
* @since 2.0-beta-6
*/
@Mojo(name = "branch", aggregator = true)
public class BranchReleaseMojo extends AbstractScmReleaseMojo {
/**
* The branch name to use.
*
* @since 2.0-beta-6
*/
@Parameter(property = "branchName")
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, http://svn.apache.org/repos/asf/maven/plugins/branches. The URL
* is an SVN URL and does not include the SCM provider and protocol.
*
* @since 2.0
*/
@Parameter(property = "branchBase")
private String branchBase;
/**
* Whether to update versions in the branch.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "false", property = "updateBranchVersions")
private boolean updateBranchVersions;
/**
* Whether to update versions in the working copy.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "true", property = "updateWorkingCopyVersions")
private boolean updateWorkingCopyVersions;
/**
* Whether to suppress a commit of changes to the working copy
* before the tag is created.
*
*
This requires remoteTagging to be set to false.
*
*
suppressCommitBeforeBranch is useful when you want
* to avoid poms with released versions in all revisions of your
* trunk or development branch.
*
* @since 2.1
*/
@Parameter(defaultValue = "false", property = "suppressCommitBeforeBranch")
private boolean suppressCommitBeforeBranch;
/**
* Whether to update versions to SNAPSHOT in the branch.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "true", property = "updateVersionsToSnapshot")
private boolean updateVersionsToSnapshot;
/**
* Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "false", property = "useEditMode")
private boolean useEditMode;
/**
* Whether to update dependencies version to the next development version.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "true", property = "updateDependencies")
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.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "false", property = "autoVersionSubmodules")
private boolean autoVersionSubmodules;
/**
* Dry run: don't checkin or tag anything in the scm repository, or modify the checkout.
* Running mvn -DdryRun=true release:prepare 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.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "false", property = "dryRun")
private boolean dryRun;
/**
* Whether to add a schema to the POM if it was previously missing on release.
*
* @since 2.0-beta-6
*/
@Parameter(defaultValue = "true", property = "addSchema")
private boolean addSchema;
/**
* currently only implemented with svn scm. Enable a workaround to prevent issue
* due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
*
* @since 2.0
*/
@Parameter(defaultValue = "true", property = "remoteTagging")
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.
*
* @since 2.1
*/
@Parameter
private String[] checkModificationExcludes;
/**
* Command-line version of checkModificationExcludes.
*
* @since 2.1
*/
@Parameter(property = "checkModificationExcludeList")
private String checkModificationExcludeList;
/**
* Specify the new version for the branch.
* This parameter is only meaningful if {@link #updateBranchVersions} = {@code true}.
*
* @since 2.0
*/
@Parameter(property = "releaseVersion")
private String releaseVersion;
/**
* Specify the new version for the working copy.
* This parameter is only meaningful if {@link #updateWorkingCopyVersions} = {@code true}.
*
* @since 2.0
*/
@Parameter(property = "developmentVersion")
private String developmentVersion;
/**
* The role-hint for the {@link org.apache.maven.shared.release.policy.version.VersionPolicy}
* implementation used to calculate the project versions.
*
* @since 3.0.0-M5
* @see org.apache.maven.shared.release.policies.DefaultVersionPolicy
*/
@Parameter(defaultValue = "default", property = "projectVersionPolicyId")
private String projectVersionPolicyId;
/**
* Optional config for the VersionPolicy implementation used to calculate the project versions.
*
* @since 3.0.0
*/
@Parameter(property = "projectVersionPolicyConfig")
private PlexusConfiguration projectVersionPolicyConfig;
/**
* The role-hint for the {@link org.apache.maven.shared.release.policy.naming.NamingPolicy}
* implementation used to calculate the project names.
*
* @since 3.0.0-M5
* @see org.apache.maven.shared.release.policies.DefaultNamingPolicy
*/
@Parameter(property = "projectNamingPolicyId")
private String projectBranchNamingPolicyId;
/**
* The SCM commit comment when branching.
* Defaults to "@{prefix} prepare branch @{branchName}".
*
* Property interpolation is performed on the value, but in order to ensure that the interpolation occurs
* during release, you must use @{...} to reference the properties rather than ${...}.
* The following properties are available:
*
* prefix - The comment prefix.
* groupId - The groupId of the root project.
* artifactId - The artifactId of the root project.
* branchName - The branch name of the root project.
*
*
* @since 3.0.0-M1
*/
@Parameter(defaultValue = "@{prefix} prepare branch @{branchName}", property = "scmBranchCommitComment")
private String scmBranchCommitComment = "@{prefix} prepare branch @{branchName}";
/**
* Currently only implemented with svn scm. Enable the {@code --pin-externals} option in
* {@code svn copy} command which is new in Subversion 1.9.
*
* @since 3.0.0-M5
*/
@Parameter(defaultValue = "false", property = "pinExternals")
private boolean pinExternals;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
super.execute();
final ReleaseDescriptorBuilder 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);
config.setProjectVersionPolicyId(projectVersionPolicyId);
if (projectVersionPolicyConfig != null) {
config.setProjectVersionPolicyConfig(projectVersionPolicyConfig.toString());
}
config.setProjectNamingPolicyId(projectBranchNamingPolicyId);
config.setScmBranchCommitComment(scmBranchCommitComment);
config.setPinExternals(pinExternals);
if (checkModificationExcludeList != null) {
checkModificationExcludes =
checkModificationExcludeList.replaceAll("\\s", "").split(",");
}
if (checkModificationExcludes != null) {
config.setCheckModificationExcludes(Arrays.asList(checkModificationExcludes));
}
try {
ReleaseBranchRequest branchRequest = new ReleaseBranchRequest();
branchRequest.setReleaseDescriptorBuilder(config);
branchRequest.setReleaseEnvironment(getReleaseEnvironment());
branchRequest.setReactorProjects(getReactorProjects());
branchRequest.setReleaseManagerListener(new DefaultReleaseManagerListener(getLog(), dryRun));
branchRequest.setDryRun(dryRun);
branchRequest.setUserProperties(session.getUserProperties());
releaseManager.branch(branchRequest);
} catch (ReleaseExecutionException e) {
throw new MojoExecutionException(e.getMessage(), e);
} catch (ReleaseFailureException e) {
throw new MojoFailureException(e.getMessage(), e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy