maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r1380689 - in /maven/plugins/trunk/maven-scm-publish-plugin/src/site: apt/examples/one-module-configuration.apt.vm apt/various-tips.apt.vm site.xml
Date Tue, 04 Sep 2012 15:45:24 GMT
Author: olamy
Date: Tue Sep  4 15:45:23 2012
New Revision: 1380689

URL: http://svn.apache.org/viewvc?rev=1380689&view=rev
Log:
start improving documentation

Added:
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
  (with props)
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm   (with
props)
Modified:
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/site.xml

Added: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm?rev=1380689&view=auto
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
(added)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
Tue Sep  4 15:45:23 2012
@@ -0,0 +1,78 @@
+ ------
+ Maven Mono Module Configuration
+ ------
+ Olivier Lamy
+ ------
+ 2012-09-04
+ ------
+
+~~ 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
+
+Maven Mono Module Configuration
+
+  <<This easy configuration works only for mono module maven build>>
+
+  With this configuration you can simply run: <<<mvn site-deploy>>>
+
++-----------------------
+
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <checkinComment>You can configure your checkin message</checkinComment>
+      </configuration>
+      <executions>
+        <execution>
+          <id>scm-publish</id>
+          <phase>site-deploy</phase>
+          <goals>
+            <goal>publish-scm</goal>
+          </goals>
+        </execution>
+      </executions>
+    </plugin>
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-site-plugin</artifactId>
+      <version>3.1</version>
+      <configuration>
+        <skipDeploy>true</skipDeploy>
+      </configuration>
+      <executions>
+        <execution>
+          <id>stage-for-scm-publish</id>
+          <phase>post-site</phase>
+          <goals>
+            <goal>stage</goal>
+          </goals>
+          <configuration>
+            <skipDeploy>false</skipDeploy>
+          </configuration>
+        </execution>
+      </executions>
+    </plugin>
+    </plugins>
+
++-----------------------
+
+

Propchange: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Added: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm?rev=1380689&view=auto
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm (added)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm Tue Sep
 4 15:45:23 2012
@@ -0,0 +1,116 @@
+ ------
+ Various Tips
+ ------
+ Olivier Lamy
+ ------
+ 2012-09-04
+ ------
+
+~~ 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
+
+Various tips for using this plugin
+
+* Some Tips to improve performance
+
+  By default, a complete checkout is done, you can configure the plugin to try update rather
than a full checkout/clone
+
++----------------
+
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <tryUpdate>true</tryUpdate>
+      </configuration>
+    </plugin>
+
++----------------
+
+  By defaut, the scm content is checkout/clone to $\{project.build.directory}/scmpublish-checkout,
so when running mvn clean
+  all the content is deleted. You can configure a path to your machine.
+  A recommended way is to use a property with a default as it your colleague will be able
to override in their settings.
+
++----------------
+    <properties>
+      ...
+      <scmPubCheckoutDirectory>$\{user.home}/my-site-content-scm</scmPubCheckoutDirectory>
+      ...
+    </properties>
+
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <checkoutDirectory>${scmPubCheckoutDirectory}</checkoutDirectory>
+        <tryUpdate>true</tryUpdate>
+        <providerImplementations>
+          <svn>javasvn</svn>
+        </providerImplementations>
+
+      </configuration>
+      <dependencies>
+        <dependency>
+          <groupId>com.google.code.maven-scm-provider-svnjava</groupId>
+          <artifactId>maven-scm-provider-svnjava</artifactId>
+          <version>${maven-scm-provider-svnjava.version}</version>
+        </dependency>
+        <dependency>
+          <groupId>org.tmatesoft.svnkit</groupId>
+          <artifactId>svnkit</artifactId>
+          <version>${svnkit.version}</version>
+        </dependency>
+      </dependencies>
+    </plugin>
++----------------
+
+  You can use svnjava rather than svn cli if you use a machine without svn cli.
+
++----------------
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <providerImplementations>
+          <svn>javasvn</svn>
+        </providerImplementations>
+      </configuration>
+      <dependencies>
+        <dependency>
+          <groupId>com.google.code.maven-scm-provider-svnjava</groupId>
+          <artifactId>maven-scm-provider-svnjava</artifactId>
+          <version>${maven-scm-provider-svnjava.version}</version>
+        </dependency>
+        <dependency>
+          <groupId>org.tmatesoft.svnkit</groupId>
+          <artifactId>svnkit</artifactId>
+          <version>${svnkit.version}</version>
+        </dependency>
+      </dependencies>
+    </plugin>
++----------------
+
+
+
+
+

Propchange: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/site.xml?rev=1380689&r1=1380688&r2=1380689&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/site.xml Tue Sep  4 15:45:23 2012
@@ -26,9 +26,10 @@ under the License.
       <item name="Introduction" href="index.html"/>
       <item name="Goals" href="plugin-info.html"/>
       <item name="Usage" href="usage.html"/>
-      <item name="Release Notes" href="jira-report.html"/>
+      <item name="Some Tips" href="various-tips.html"/>
     </menu>
     <menu name="Example">
+      <item name="Maven Mono Module Configuration" href="examples/one-module-configuration.html"/>
       <item name="Importing Maven sites" href="examples/importing-maven-site.html"/>
     </menu>
   </body>



Mime
View raw message