maven-plugins/scm/xdocs/commontasks.xml

59 lines
2.1 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>Common SCM Tasks</title>
<author email="brett@apache.org">Brett Porter</author>
</properties>
<body>
<section name="Common SCM Tasks">
<p>
The Maven SCM plugin allows you to perform some common SCM actions.
</p>
<subsection name="Checking out a project">
<p>
This command is usually performed without a project, as that is what you are
checking out, so you need to specify the <a href="scmurl.html">SCM URL</a>. The URL takes the same format
as the <code>&lt;repository&gt;&lt;connection&gt;</code> element in your <code>project.xml</code>
file.
</p>
<source>maven scm:checkout -Dmaven.scm.url=scm:svn:http://svn.apache.org/repos/asf/maven/maven-1/core/trunk</source>
</subsection>
<subsection name="Updating a project">
<p>
This command is always performed on an existing project. It is used to update to the latest code from the
server for the project.
</p>
<source>maven scm:update</source>
</subsection>
<subsection name="Tagging a project">
<p>
This command is always performed on an existing project. It will apply a tag (or equivalent operation in
your SCM) to the current checkout. You must specify a tag name.
</p>
<source>maven scm:tag -Dmaven.scm.tag=MAVEN_1_0</source>
</subsection>
</section>
</body>
</document>