Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
scm:add	Add a file set to the project.
scm:bootstrap	Pull the project source from the configured scm and execute the configured goals.
scm:branch	Branch the project.
scm:changelog	Dump changelog contents to console. It is mainly used to test maven-scm-api's changelog command.
scm:check-local-modification	This mojo will fail the build if there is any local modifications
scm:checkin	Commit changes to the configured scm url.
scm:checkout	Get a fresh copy of the latest source from the configured scm url.
scm:diff	Display the difference of the working copy with the latest copy in the configured scm url.
scm:edit	Edit/lock a set of files.
scm:export	Get a fresh exported copy of the latest source from the configured scm url.
scm:help	Display help information on maven-scm-plugin. Call `mvn scm:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
scm:list	Get the list of project files.
scm:remove	Mark a set of files for deletion.
scm:status	Display the modification status of the files in the configured scm url.
scm:tag	Tag the project.
scm:unedit	Unedit/unlock a set of files.
scm:untag	Untag the project.
scm:update	Update the local working copy with the latest source from the configured scm url.
scm:update-subprojects	Updates all projects in a multi project build. This is useful for users who have adopted the flat project structure where the aggregator project is a sibling of the sub projects rather than sitting in the parent directory.
scm:validate	Validate scm connection string.
scm:validate-recursively	Validate scm connection string recursively for all projects

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.6.3
JDK	1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
from 2.1.0 to 2.2.0	3.6.3	8
from 2.0.0-M2 to 2.0.1	3.2.5	8
2.0.0-M1	2.2.1	7
1.13.0	3.2.5	7
from 1.10.0 to 1.12.2	2.2.1	7
1.9.5	2.2.1	6
1.9.4	2.2.1	5
from 1.8 to 1.9.2	-	5
from 1.5 to 1.7	2.0.6	5
from 1.1 to 1.4	2.0.6	1.4
from 1.0-beta-4 to 1.0	2.0.1	1.4
1.0-beta-3	-	1.4
from 1.0-alpha-2 to 1.0-beta-2	-	-

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-scm-plugin</artifactId>
          <version>2.2.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-scm-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"