Author: sebb
Date: Mon Sep 28 19:55:35 2015
New Revision: 1705756
URL: http://svn.apache.org/viewvc?rev=1705756&view=rev
Log:
Add support for building RN from changes.xml
TODO: rename the output file once the original RN have been incorporated into
changes.xml/release-notes.vm
Added:
creadur/rat/trunk/RELEASE-NOTES.txt (with props)
creadur/rat/trunk/src/changes/release-notes.vm (with props)
Modified:
creadur/rat/trunk/pom.xml
creadur/rat/trunk/src/changes/changes.xml
Added: creadur/rat/trunk/RELEASE-NOTES.txt
URL:
http://svn.apache.org/viewvc/creadur/rat/trunk/RELEASE-NOTES.txt?rev=1705756&view=auto
==============================================================================
--- creadur/rat/trunk/RELEASE-NOTES.txt (added)
+++ creadur/rat/trunk/RELEASE-NOTES.txt Mon Sep 28 19:55:35 2015
@@ -0,0 +1,27 @@
+ Apache Creadur Rat 0.11
+ RELEASE NOTES
+
+The Apache Creadur Rat team is pleased to announce the release of Apache
Creadur Rat 0.11
+
+Apache Rat is a release audit tool. It improves accuracy and efficiency when
checking
+releases. It is heuristic in nature: making guesses about possible problems. It
+will produce false positives and cannot find every possible issue with a
release.
+It's reports require interpretation.
+
+In response to demands from project quality tool developers, Rat is available
as a
+library suitable for inclusion in tools. This POM describes that library.
+Note that binary compatibility is not guaranteed between 0.x releases.
+
+Apache Rat is developed by the Apache Creadur project, a language and build
+agnostic home for software distribution comprehension and audit tools.
+
+TBA
+
+No changes defined in this version.
+
+Historical list of changes: http://creadur.apache.org/rat/changes-report.html
+
+For complete information on Apache Creadur Rat, including instructions on how
to submit bug reports,
+patches, or suggestions for improvement, see the Apache Apache Creadur Rat
website:
+
+http://creadur.apache.org/rat/
Propchange: creadur/rat/trunk/RELEASE-NOTES.txt
------------------------------------------------------------------------------
svn:eol-style = native
Modified: creadur/rat/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/creadur/rat/trunk/pom.xml?rev=1705756&r1=1705755&r2=1705756&view=diff
==============================================================================
--- creadur/rat/trunk/pom.xml (original)
+++ creadur/rat/trunk/pom.xml Mon Sep 28 19:55:35 2015
@@ -32,7 +32,7 @@
Apache Rat is a release audit tool. It improves accuracy and efficiency when
checking
releases. It is heuristic in nature: making guesses about possible problems. It
will produce false positives and cannot find every possible issue with a
release.
-It's reports require interpretation.
+Its reports require interpretation.
In response to demands from project quality tool developers, Rat is available
as a
library suitable for inclusion in tools. This POM describes that library.
@@ -76,6 +76,7 @@ agnostic home for software distribution
<rat.site.id>org.apache.rat.site</rat.site.id>
<!-- maven plugin versions -->
<mavenPluginPluginVersion>3.3</mavenPluginPluginVersion>
+ <mavenChangesVersion>2.11</mavenChangesVersion>
</properties>
<dependencyManagement>
<dependencies>
@@ -643,6 +644,46 @@ agnostic home for software distribution
</execution>
</executions>
</plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <!--
+ Generate release notes in top-level directory from
src/changes/changes.xml
+ Usage:
+ mvn changes:announcement-generate -Prelease-notes
[-Dchanges.version=nnn]
+
+ Defining changes.version allows one to create the RN without first
removing the SNAPSHOT suffix.
+
+ Requires file src/changes/release-notes.vm.
+ -->
+ <id>release-notes</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <version>${mavenChangesVersion}</version>
+ <configuration>
+ <template>release-notes.vm</template>
+ <templateDirectory>src/changes</templateDirectory>
+ <runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
+ <announcementDirectory>.</announcementDirectory>
+ <announcementFile>RELEASE-NOTES.txt</announcementFile>
+ <announceParameters>
+ <releaseVersion>${mavenChangesVersion}</releaseVersion>
+ </announceParameters>
+ </configuration>
+ <executions>
+ <execution>
+ <id>create-release-notes</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>announcement-generate</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
</profile>
Modified: creadur/rat/trunk/src/changes/changes.xml
URL:
http://svn.apache.org/viewvc/creadur/rat/trunk/src/changes/changes.xml?rev=1705756&r1=1705755&r2=1705756&view=diff
==============================================================================
--- creadur/rat/trunk/src/changes/changes.xml (original)
+++ creadur/rat/trunk/src/changes/changes.xml Mon Sep 28 19:55:35 2015
@@ -15,12 +15,57 @@
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>
<properties>
- <title>Changes in Rat</title>
+ <title>Changes in Apache Creadur RAT</title>
+ <author email="[email protected]">Apache Creadur RAT
developers</author>
</properties>
+
<body>
- <release version="0.6.0" date="Not yet released">
+ <release version="0.11" date="2014-08-31" description="TBA"></release>
+ <release version="0.10" date="2013-09-05" description=
+"The 0.10 version includes several bug fixes,
+most notably a fix for 0.9 performance issues."></release>
+ <release version="0.9" date="2013-05-02" description="TBA"></release>
+ <release version="0.8-incubating" date="2011-11-15" description=
+"Version 0.8 improves the command line interface, supports more file
+types when adding license headers and makes it easier to detect custom
+licenses.">
+ </release>
+ <release version="0.7-incubating" date="2013-05-02" description=
+"The following changes have been made in Apache RAT 0.7:
+
+- Add support for Python scripts, C source files, Unix shell scripts (.sh) and
Windows batch files (.bat) (RAT-68)
+- Allow Ant task to output report as XML. (RAT-73)
+- Allow users to specify a custom XSLT stylesheet for reports (RAT-74, and
RAT-75)
+- Optionally auto-add headers to source files. (RAT-76) ">
+ </release>
+ <release version="0.6-incubating" date="2009-04-10" description=
+"This is the first version using the org.apache package
+structure and related names. RAT users are strongly encouraged to
+migrate, as the old Google version will no longer be maintained.">
<action dev="jochen" type="fix" issue="RAT-37"
due-to="Jukka Zitting" due-to-email="[email protected]">
List all resources with unapproved licenses at the beginning of the
report.
Added: creadur/rat/trunk/src/changes/release-notes.vm
URL:
http://svn.apache.org/viewvc/creadur/rat/trunk/src/changes/release-notes.vm?rev=1705756&view=auto
==============================================================================
--- creadur/rat/trunk/src/changes/release-notes.vm (added)
+++ creadur/rat/trunk/src/changes/release-notes.vm Mon Sep 28 19:55:35 2015
@@ -0,0 +1,122 @@
+## 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}
+ 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 < with < so can embed tag markup
+#set($action=$action.replaceAll("<","<"))
+## 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}
Propchange: creadur/rat/trunk/src/changes/release-notes.vm
------------------------------------------------------------------------------
svn:eol-style = native
