You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2012/06/21 23:40:20 UTC

svn commit: r1352705 - in /maven/release/trunk/maven-release-plugin/src: it/projects/prepare/MRELEASE-156/ it/projects/prepare/MRELEASE-156/pom.xml it/projects/prepare/MRELEASE-156/verify.groovy site/fml/faq.fml

Author: rfscholte
Date: Thu Jun 21 21:40:20 2012
New Revision: 1352705

URL: http://svn.apache.org/viewvc?rev=1352705&view=rev
Log:
IT for MRELEASE-156 + improve FAQ

Added:
    maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/
    maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/pom.xml
    maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/verify.groovy
Modified:
    maven/release/trunk/maven-release-plugin/src/site/fml/faq.fml

Added: maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/pom.xml
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/pom.xml?rev=1352705&view=auto
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/pom.xml (added)
+++ maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/pom.xml Thu Jun 21 21:40:20 2012
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ 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.
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>org.apache.maven.plugin.release.its</groupId>
+  <artifactId>mrelease-156</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  
+  <description>
+    Multiline scmCommentPrefix
+  </description>
+
+  <scm>
+    <connection>scm:dummy|nul</connection>
+    <developerConnection>scm:dummy|nul</developerConnection>
+  </scm>
+  
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-release-plugin</artifactId>
+        <version>@project.version@</version>
+        <configuration>
+          <scmCommentPrefix>ABCD-1234${line.separator}</scmCommentPrefix>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>org.apache.maven.its.release</groupId>
+            <artifactId>maven-scm-provider-dummy</artifactId>
+            <version>1.0</version>
+          </dependency>
+        </dependencies>
+      </plugin>
+    </plugins>
+  </build>
+</project>
\ No newline at end of file

Added: maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/verify.groovy
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/verify.groovy?rev=1352705&view=auto
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/verify.groovy (added)
+++ maven/release/trunk/maven-release-plugin/src/it/projects/prepare/MRELEASE-156/verify.groovy Thu Jun 21 21:40:20 2012
@@ -0,0 +1,23 @@
+
+/*
+ * 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.
+ */
+
+File releaseProperties = new File( basedir, 'release.properties' )
+assert releaseProperties.exists()
+assert 1 == releaseProperties.getText().count( "scm.commentPrefix=ABCD-1234" + File.separator )
\ No newline at end of file

Modified: maven/release/trunk/maven-release-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/fml/faq.fml?rev=1352705&r1=1352704&r2=1352705&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/fml/faq.fml (original)
+++ maven/release/trunk/maven-release-plugin/src/site/fml/faq.fml Thu Jun 21 21:40:20 2012
@@ -66,10 +66,25 @@ mvn -N -Darguments=-N release:perform
     </faq>
     <faq id="scmCommentPrefix"> <!-- MRELEASE-156 -->
       <question>How can I customize the comment prefix of a commit during release preparation?</question>
-      <answer>By default the plugin will prefix the comment with <pre>[maven-release-plugin] </pre>.
-        You can change this by adding <pre>-DscmCommentPrefix=#42</pre> to the Maven command.
-        If you need to end this with a linebreak, add <pre>ALT 10</pre>(=Line Feed) and/or <pre>ALT 13</pre> (=Carriage Return) depending on the operating system.
-        If the comment prefix contains whitespace characters, surround the argument with quotes. 
+      <answer>
+        <p>
+        By default the plugin will prefix the comment with <code>[maven-release-plugin] </code>.
+        You can change this by adding <code>-DscmCommentPrefix=#42</code> to the Maven command.<br/>
+        If you need to end this with a linebreak, add <code>${line.separator}</code>.<br/>
+        If the comment prefix contains whitespace characters, surround the argument with quotes.
+        </p>
+        <p>
+        When using the plugin-configuration, you can't end with a space, because Plexus will trim the content.
+        But you can end with a linebreak just like the example above:
+        </p>
+<source>
+<![CDATA[
+  <configuration>
+    <scmCommentPrefix>#42${line.separator}</scmCommentPrefix>
+    ...
+  </configuration>
+]]>
+</source>
       </answer>
     </faq>
     <faq id="inheritScm">