You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm-commits@maven.apache.org by vs...@apache.org on 2008/08/13 22:16:13 UTC
svn commit: r685665 - in /maven/scm/trunk/maven-scm-plugin/src/site/apt:
examples/bootstrapping-with-pom.apt examples/scm-advance-features.apt
usage.apt
Author: vsiveton
Date: Wed Aug 13 13:16:12 2008
New Revision: 685665
URL: http://svn.apache.org/viewvc?rev=685665&view=rev
Log:
o added license header
o normalized snippet
o fixed typo
Modified:
maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt
maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt
maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt
Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt?rev=685665&r1=685664&r2=685665&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt (original)
+++ maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt Wed Aug 13 13:16:12 2008
@@ -3,20 +3,40 @@
------
Pete Marvin King
------
- 20 July 2006
+ 2008-08-13
------
-
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Bootstrapping a Project Using a POM
Using the <<<scm:bootstrap>>> a project can be build from a fresh copy of the source in the scm repository.
This is a convenient way to distribute a project because the bootstrap pom can be given to a developer to generate
- the maven build environment for the project.
-
- The <<<pom.xml>>> should contain a scm configuration for the bootstrap to work.
-
+ the maven build environment for the project.
+
+ The <<<pom.xml>>> should contain a scm configuration for the bootstrap to work.
+
+-----------+
<project>
- [...]
+ ...
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>SCM Sample Project</name>
@@ -26,9 +46,9 @@
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
<url>http://somerepository.com/view.cvs</url>
<scm>
- [...]
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -39,32 +59,33 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
</build>
- [...]
+ ...
</project>
-+-----------+
++-----------+
+
+ Assuming the scm configuration has been configured in the <<<pom.xml>>>, bootstrapping can be invoked by
- Assuming the scm configuration has been configured in the <<<pom.xml>>>, bootstrapping can be invoked by
-
+---------+
mvn scm:bootstrap
-+---------+
++---------+
+
+ By default the scm plugin will get the latest version from the trunk and generate it under <<<target/checkout>>> and execute
+ the configured goals in it.
- By default the scm plugin will get the latest version from the trunk and generate it under <<<target/checkout>>> and execute
- the configured goals in it.
-
Configuring Authentication
Most public repositories requires developers to authenticate first before they can pull the source from the repository.
For repository requiring authentication, the scm plugin needs to be configured in the <<<pom.xml>>>
-
- * specifying the username and password for svn and starteam
-
-+-----------+
- [...]
+
+ * specifying the username and password for svn and starteam
+
++-----------+
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -76,7 +97,8 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
</build>
- [...]
-+-----------+
+ ...
+</project>
++-----------+
Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt?rev=685665&r1=685664&r2=685665&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt (original)
+++ maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt Wed Aug 13 13:16:12 2008
@@ -3,15 +3,36 @@
------
Pete Marvin King
------
- 20 July 2006
- ------
-
+ 2008-08-13
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Other SCM Commands
The scm plugin requires the scm to be configured in the <<<pom.xml>>>.
-
+
+---------+
- [...]
+<project>
+ ...
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>SCM Sample Project</name>
@@ -21,16 +42,18 @@
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
<url>http://somerepository.com/view.cvs</url>
</scm>
- [...]
+ ...
+</project>
+---------+
If you want to change the default scm provider implementation, for exemple you want to use the native cvs
instead of the pure java implementation, you must configure your plugin like that:
+-----------+
- [...]
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -41,23 +64,25 @@
</providerImplementations>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
+ ...
+</project>
++-----------+
Once the scm has been configured, scm operations can be performed.
-
+
* changelog - displays the project commit changes for each revisions
<<<pom.xml>>> configuration :
-
+
+-----------+
- [...]
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -68,34 +93,36 @@
<endDate>YYYY-MM-DD</endDate>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
-
+ ...
+</project>
++-----------+
+
Command :
-
+
+---------+
mvn scm:changelog
-+---------+
-
++---------+
+
or you can specify the startDate and endDate on the commandline
-
+
+---------+
mvn -DstartDate=YYYY-MM-DD -DendDate=YYYY-MM-DD scm:changelog
-+---------+
-
-
++---------+
+
+
* diff
<<<pom.xml>>> configuration :
-
+
+-----------+
- [...]
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -103,52 +130,54 @@
<version>1.0</version>
<configuration>
<startRevision>connection</startRevision>
- <endRevision>connection</endRevision>
+ <endRevision>connection</endRevision>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
+ ...
+</project>
++-----------+
Command :
-
+
+---------+
mvn scm:diff
-+---------+
-
++---------+
+
or you can specify the startRevision and endRevision in the command line
-
+
+---------+
mvn -DstartRevision=<revision> -DendRevision=<revision> scm:diff
-+---------+
-
++---------+
+
* edit - set the edit status of the file, locking the project sources if supported.
Command :
-
+
+---------+
mvn scm:edit
-+---------+
-
++---------+
+
* status - displays the modified files in the project.
Command :
-
+
+---------+
mvn scm:status
-+---------+
-
++---------+
+
* tag
<<<pom.xml>>> configuration :
-
+
+-----------+
- [...]
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -158,44 +187,45 @@
<tag>tag name</tag>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
+ ...
+</project>
++-----------+
Command :
-
+
+---------+
mvn scm:tag
-+---------+
++---------+
or you can specify the tag name in the command line
-
+
+---------+
mvn -Dtag="<tag name>" scm:tag
-+---------+
-
++---------+
+
* unedit - unset the edit status of the project sources and unlocking it if supported.
Command :
-
+
+---------+
mvn scm:unedit
-+---------+
-
++---------+
+
* validate - check if the scm urls configured in the <<<pom.xml>>> is valid.
Command :
-
+
+---------+
mvn scm:validate
-+---------+
-
++---------+
+
or passing the scmConnection or/and the developerConnection in the command line
-
+
+---------+
mvn -DscmConnection="<scm url>" -DscmDeveloperConnection="<scm url>" scm:validate
-+---------+
-
++---------+
+
Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt?rev=685665&r1=685664&r2=685665&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt (original)
+++ maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt Wed Aug 13 13:16:12 2008
@@ -3,28 +3,51 @@
------
Pete Marvin King
------
- 18 July 2006
+ 2008-08-13
------
-
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Usage
- The scm plugin maps a lot of commands to a variety of scm implementations. But there are only 2 frequently
+ The scm plugin maps a lot of commands to a variety of scm implementations. But there are only 2 frequently
used commands:
-
- * checkin - commit the changes to the remote repository ( scm server ).
-
- * update - updates the local working copy with the one from the remote repository ( scm server ).
-
-Configuring SCM
+
+ * checkin - commit the changes to the remote repository ( scm server ).
+
+ * update - updates the local working copy with the one from the remote repository ( scm server ).
+
+ []
+
+Configuring SCM
Each scm has a different command line invocation to commit the modified sources. Using maven this process is
simplified by providing a uniform way to do this by letting maven handle the command line translation to perform
the scm task.
To configure the scm support for maven you need the scm configuration in your <<<pom.xml>>>.
-
+
+---------+
- [...]
+<project>
+ ...
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>SCM Sample Project</name>
@@ -34,44 +57,46 @@
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
<url>http://somerepository.com/view.cvs</url>
</scm>
- [...]
+ ...
+</project>
+---------+
-
+
Maven will use the information embedded in the scm configuration to determine the command mapping for the scm command.
The scm configuration url is composed of different information that defines the mapping:
-
+
+------+
scm:svn:http://somerepository.com/svn_repo/trunk
<service name>:<scm implementation>:<repository url>
+------+
-
+
Check the {{{http://maven.apache.org/scm/scms-overview.html}maven scm list}} for the list of supported SCMs.
-
+
Committing and updating changes through Maven
- Assuming that SCM has been configured in the <<<pom.xml>>> and the project directory is managed by a SCM, invoking
+ Assuming that SCM has been configured in the <<<pom.xml>>> and the project directory is managed by a SCM, invoking
the checkin goal in the scm will start the commit process for all configured sources in your <<<pom.xml>>>.
-
+
<<The files should be added beforehand by an external scm client.>>
-
-+-----+
+
++-----+
mvn -Dmessage="<commit_log_here>" scm:checkin
-+-----+
-
- for update
-
-+-----+
++-----+
+
+ for update
+
++-----+
mvn scm:update
-+-----+
++-----+
Specifying the scm connection to use
There two possible scm connections that can be used in the <<<pom.xml>>>, connection and developerConnection.
-
+
* connection configuration
-
+
+-----------+
- [...]
+<project>
+ ...
<build>
[...]
<plugins>
@@ -83,19 +108,21 @@
<connectionType>connection</connectionType>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
+ ...
+</project>
++-----------+
* developerConnection configuration
-
+
+-----------+
- [...]
+<project>
+ ...
<build>
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -105,15 +132,16 @@
<connectionType>developerConnection</connectionType>
</configuration>
</plugin>
- [...]
+ ...
</plugins
- [...]
+ ...
</build>
- [...]
-+-----------+
-
-
+ ...
+</project>
++-----------+
+
Related Links
- {{{http://docs.codehaus.org/display/SCM/SCM+Matrix}SCM Plugin Matrix}}
-
\ No newline at end of file
+ * {{{http://docs.codehaus.org/display/SCM/SCM+Matrix}SCM Plugin Matrix}}
+
+ []