Plugin Documentation
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: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. |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven | 2.0 |
JDK | 1.5 |
Memory | No minimum requirement. |
Disk Space | No minimum requirement. |
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>1.8</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> <version>1.8</version> </plugin> ... </plugins> </build> ... </project>
For more information, see "Guide to Configuring Plug-ins"