You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2013/06/21 13:52:23 UTC

svn commit: r1495397 - in /commons/proper/commons-gpg-plugin/trunk: RELEASE-NOTES.txt src/changes/ src/changes/changes.xml src/changes/release-notes.vm

Author: sebb
Date: Fri Jun 21 11:52:22 2013
New Revision: 1495397

URL: http://svn.apache.org/r1495397
Log:
Add release notes and start changes file

Added:
    commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt   (with props)
    commons/proper/commons-gpg-plugin/trunk/src/changes/
    commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml   (with props)
    commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm   (with props)

Added: commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt
URL: http://svn.apache.org/viewvc/commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt?rev=1495397&view=auto
==============================================================================
--- commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt (added)
+++ commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt Fri Jun 21 11:52:22 2013
@@ -0,0 +1,19 @@
+              Apache Commons Gpg Maven Mojo
+                    Version 1.0
+                   RELEASE NOTES
+
+The Apache Commons Gpg Maven Mojo team is pleased to announce the release of Apache Commons Gpg Maven Mojo 1.0
+
+Apache Maven GPG plugin which allows arbitrary files to be signed.
+This is intended as a temporary measure until MGPG-43 is implemented.
+
+This is the initial release of the Commons Gpg Maven Plugin.
+
+No changes defined in this version.
+
+Historical list of changes: http://commons.apache.org/proper/commons-gpg-plugin/changes-report.html
+
+For complete information on Apache Commons Gpg Maven Mojo, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Apache Commons Gpg Maven Mojo website:
+
+http://commons.apache.org/proper/commons-gpg-plugin/
\ No newline at end of file

Propchange: commons/proper/commons-gpg-plugin/trunk/RELEASE-NOTES.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Added: commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml?rev=1495397&view=auto
==============================================================================
--- commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml (added)
+++ commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml Fri Jun 21 11:52:22 2013
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<!--
+
+   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.
+
+-->
+<!--
+This file is also used by the maven-changes-plugin to generate the release notes.
+Useful ways of finding items to add to this file are:
+
+1.  Add items when you fix a bug or add a feature (this makes the 
+release process easy :-).
+
+2.  Do a JIRA search for tickets closed since the previous release.
+
+3.  Use the report generated by the maven-changelog-plugin to see all
+SVN commits. TBA how to use this with SVN.
+
+To generate the release notes from this file:
+
+mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nn]
+then tweak the formatting if necessary 
+and commit
+
+The <action> type attribute can be add,update,fix,remove.
+-->
+
+<document xmlns="http://maven.apache.org/changes/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/xsd/changes-1.0.0.xsd">
+    <properties>
+        <title>Commons GpG Maven Plugin: Changes</title>
+        <author email="dev@commons.apache.org">Apache Commons devlopers</author>
+    </properties>
+
+    <!-- NOTE: 
+    The description below is specially formatted so as to improve the layout of the generated release notes:
+    The parsing process removes all line feeds, replacing them with a single space.
+    The Velocity template in resources/templates has been enhanced to replace pairs of adjacent spaces
+    with a new-line in the release notes. (These spaces are ignored when displaying HTML).
+    If the output is not quite correct, check for invisible trailing spaces!
+
+    To suppress formatting of an action entry when generating release notes, add an empty date.
+    This does not affect the HTML changes report (in any case dates are not displayed by default)
+    
+    N.B. The release notes template groups actions by type, and only extracts data for the current release.
+    The changes report outputs actions in the order they appear in this file. 
+     -->
+
+    <body>
+
+        <release version="1.0" date="2013-06-24" description="
+This is the initial release of the Commons Gpg Maven Plugin.
+">
+            <!-- List each change individually so the changes html report is easier to read -->
+        </release>
+
+    </body>
+</document>

Propchange: commons/proper/commons-gpg-plugin/trunk/src/changes/changes.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm
URL: http://svn.apache.org/viewvc/commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm?rev=1495397&view=auto
==============================================================================
--- commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm (added)
+++ commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm Fri Jun 21 11:52:22 2013
@@ -0,0 +1,123 @@
+## 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.name}
+                    Version ${version}
+                   RELEASE NOTES
+
+The ${developmentTeam} is pleased to announce the release of ${project.name} ${version}
+
+$introduction.replaceAll("(?<!\015)\012", "
+").replaceAll("(?m)^ +","")
+
+## N.B. the available variables are described here:
+## http://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html
+##
+## Hack to improve layout: replace all pairs of spaces with a single new-line
+$release.description.replaceAll("  ", "
+")
+
+## set up indent sizes. Only change indent1
+#set($props=${project.properties})
+#set($jiralen=$props.get("commons.jira.id").length())
+## indent1 =   POOL-nnnn:
+#set($blanklen=$jiralen+6)## +6 for "-nnnn:"
+## must be at least as long as the longest JIRA id
+#set($blanks="                                  ")
+#set($indent1=$blanks.substring(0,$blanklen))
+## indent2 allows for issue wrapper
+#set($indent2="$indent1   ")
+##
+#macro ( processaction )
+## Use replaceAll to fix up LF-only line ends on Windows.
+#set($action=$actionItem.getAction().replaceAll("\n","
+"))
+## Replace &lt; with < so can embed tag markup
+#set($action=$action.replaceAll("&lt;","<"))
+## use an empty date to mean don't format the entry
+## TODO how to enable leading spaces without compromising html report
+## unfortunately leading spaces are trimmed even from CDATA sections
+#if ($actionItem.getDate() && $actionItem.getDate().length()==0)
+$action
+#else
+## Fix up indentation for multi-line action descriptions
+#set($action=$action.replaceAll("(?m)^  +",$indent2))
+#if ($actionItem.getIssue())
+#set($issue="$actionItem.getIssue():")
+## Pad shorter issue numbers
+#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
+#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
+#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
+#else
+#set($issue=$indent1)
+#end
+#if ($actionItem.getDueTo())
+#set($dueto=" Thanks to $actionItem.getDueTo().")
+#else
+#set($dueto="")
+#end
+o $issue ${action}$dueto
+#end
+#set($action="")
+#set($issue="")
+#set($dueto="")
+#end
+##
+#if ($release.getActions().size() == 0)
+No changes defined in this version.
+#else
+Changes in this version include:
+
+#if ($release.getActions('add').size() !=0)
+New features:
+#foreach($actionItem in $release.getActions('add'))
+#processaction()
+#end 
+
+#end
+##
+#if ($release.getActions('fix').size() !=0)
+Fixed Bugs:
+#foreach($actionItem in $release.getActions('fix'))
+#processaction()
+#end
+
+#end
+##
+#if ($release.getActions('update').size() !=0)
+Changes:
+#foreach($actionItem in $release.getActions('update'))
+#processaction()
+#end
+
+#end
+##
+#if ($release.getActions('remove').size() !=0)
+Removed:
+#foreach($actionItem in $release.getActions('remove'))
+#processaction()
+#end
+#end
+## End of main loop
+#end
+
+Historical list of changes: ${project.url}changes-report.html
+
+For complete information on ${project.name}, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache ${project.name} website:
+
+${project.url}
\ No newline at end of file

Propchange: commons/proper/commons-gpg-plugin/trunk/src/changes/release-notes.vm
------------------------------------------------------------------------------
    svn:eol-style = native