View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.scm.plugin;
20  
21  import java.io.IOException;
22  
23  import org.apache.maven.plugin.MojoExecutionException;
24  import org.apache.maven.plugins.annotations.Mojo;
25  import org.apache.maven.plugins.annotations.Parameter;
26  import org.apache.maven.scm.ScmException;
27  import org.apache.maven.scm.command.checkin.CheckInScmResult;
28  import org.apache.maven.scm.repository.ScmRepository;
29  
30  /**
31   * Commit changes to the configured scm url.
32   *
33   * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
34   */
35  @Mojo(name = "checkin", aggregator = true)
36  public class CheckinMojo extends AbstractScmMojo {
37      /**
38       * Commit log.
39       */
40      @Parameter(property = "message")
41      private String message;
42  
43      /**
44       * The configured scm url to use.
45       */
46      @Parameter(property = "connectionType", defaultValue = "developerConnection")
47      private String connectionType;
48  
49      /**
50       * The version type (branch/tag/revision) of scmVersion.
51       */
52      @Parameter(property = "scmVersionType")
53      private String scmVersionType;
54  
55      /**
56       * The version (revision number/branch name/tag name).
57       */
58      @Parameter(property = "scmVersion")
59      private String scmVersion;
60  
61      /** {@inheritDoc} */
62      public void execute() throws MojoExecutionException {
63          super.execute();
64  
65          setConnectionType(connectionType);
66  
67          try {
68              ScmRepository repository = getScmRepository();
69  
70              CheckInScmResult result = getScmManager()
71                      .checkIn(repository, getFileSet(), getScmVersion(scmVersionType, scmVersion), message);
72  
73              checkResult(result);
74          } catch (IOException | ScmException e) {
75              throw new MojoExecutionException("Cannot run checkin command : ", e);
76          }
77      }
78  }