org.apache.maven.scm.plugin.CheckinMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-scm-plugin Show documentation

Maven Plugin that allows accessing different SCMs.

There is a newer version: 2.1.0

/*
 * 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.scm.plugin;

import java.io.IOException;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.scm.ScmException;
import org.apache.maven.scm.command.checkin.CheckInScmResult;
import org.apache.maven.scm.repository.ScmRepository;

/**
 * Commit changes to the configured scm url.
 *
 * @author Emmanuel Venisse
 */
@Mojo(name = "checkin", aggregator = true)
public class CheckinMojo extends AbstractScmMojo {
    /**
     * Commit log.
     */
    @Parameter(property = "message")
    private String message;

    /**
     * The configured scm url to use.
     */
    @Parameter(property = "connectionType", defaultValue = "developerConnection")
    private String connectionType;

    /**
     * The version type (branch/tag/revision) of scmVersion.
     */
    @Parameter(property = "scmVersionType")
    private String scmVersionType;

    /**
     * The version (revision number/branch name/tag name).
     */
    @Parameter(property = "scmVersion")
    private String scmVersion;

    /** {@inheritDoc} */
    public void execute() throws MojoExecutionException {
        super.execute();

        setConnectionType(connectionType);

        try {
            ScmRepository repository = getScmRepository();

            CheckInScmResult result = getScmManager()
                    .checkIn(repository, getFileSet(), getScmVersion(scmVersionType, scmVersion), message);

            checkResult(result);
        } catch (IOException | ScmException e) {
            throw new MojoExecutionException("Cannot run checkin command : ", e);
        }
    }
}