Get 'mvn clean site' to work.
[commons-testing.git] / src / changes / release-notes.vm
1 ## Licensed to the Apache Software Foundation (ASF) under one\r
2 ## or more contributor license agreements.  See the NOTICE file\r
3 ## distributed with this work for additional information\r
4 ## regarding copyright ownership.  The ASF licenses this file\r
5 ## to you under the Apache License, Version 2.0 (the\r
6 ## "License"); you may not use this file except in compliance\r
7 ## with the License.  You may obtain a copy of the License at\r
8 ##\r
9 ##  http://www.apache.org/licenses/LICENSE-2.0\r
10 ##\r
11 ## Unless required by applicable law or agreed to in writing,\r
12 ## software distributed under the License is distributed on an\r
13 ## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\r
14 ## KIND, either express or implied.  See the License for the\r
15 ## specific language governing permissions and limitations\r
16 ## under the License.\r
17 ##\r
18 \r
19 Licensed to the Apache Software Foundation (ASF) under one or more\r
20 contributor license agreements.  See the NOTICE file distributed with\r
21 this work for additional information regarding copyright ownership.\r
22 The ASF licenses this file to You under the Apache License, Version 2.0\r
23 (the "License"); you may not use this file except in compliance with\r
24 the License.  You may obtain a copy of the License at\r
25 \r
26 http://www.apache.org/licenses/LICENSE-2.0\r
27 \r
28 Unless required by applicable law or agreed to in writing, software\r
29 distributed under the License is distributed on an "AS IS" BASIS,\r
30 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
31 See the License for the specific language governing permissions and\r
32 limitations under the License.\r
33 \r
34 \r
35                         ${project.name}\r
36                             Version ${version}\r
37                            Release Notes\r
38 \r
39 \r
40 INTRODUCTION:\r
41 \r
42 This document contains the release notes for the ${version} version of Apache Commons Testing.\r
43 Commons Testing is a set of utility functions and reusable components that should be of use in any \r
44 Java environment.\r
45 \r
46 Commons Testing 1.0.0 targets Java 7.\r
47 \r
48 $introduction.replaceAll("(?<!\015)\012", "\r
49 ").replaceAll("(?m)^ +","")\r
50 \r
51 ## N.B. the available variables are described here:\r
52 ## http://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html\r
53 ##\r
54 ## Hack to improve layout: replace all pairs of spaces with a single new-line\r
55 $release.description.replaceAll("  ", "\r
56 ")\r
57 \r
58 ## set up indent sizes. Only change indent1\r
59 #set($props=${project.properties})\r
60 #set($jiralen=$props.get("commons.jira.id").length())\r
61 ## indent1 =   POOL-nnnn:\r
62 #set($blanklen=$jiralen+6)## +6 for "-nnnn:"\r
63 ## must be at least as long as the longest JIRA id\r
64 #set($blanks="                                  ")\r
65 #set($indent1=$blanks.substring(0,$blanklen))\r
66 ## indent2 allows for issue wrapper\r
67 #set($indent2="$indent1   ")\r
68 ##\r
69 #macro ( processaction )\r
70 ## Use replaceAll to fix up LF-only line ends on Windows.\r
71 #set($action=$actionItem.getAction().replaceAll("\n","\r
72 "))\r
73 ## Fix up indentation for multi-line action descriptions\r
74 #set($action=$action.replaceAll("(?m)^  +",$indent2))\r
75 #if ($actionItem.getIssue())\r
76 #set($issue="$actionItem.getIssue():")\r
77 ## Pad shorter issue numbers\r
78 #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end\r
79 #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end\r
80 #if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end\r
81 #else\r
82 #set($issue=$indent1)\r
83 #end\r
84 #if ($actionItem.getDueTo())\r
85 #set($dueto=" Thanks to $actionItem.getDueTo().")\r
86 #else\r
87 #set($dueto="")\r
88 #end\r
89 o $issue ${action}$dueto\r
90 #set($action="")\r
91 #set($issue="")\r
92 #set($dueto="")\r
93 #end\r
94 ##\r
95 #if ($release.getActions().size() == 0)\r
96 No changes defined in this version.\r
97 #else\r
98 Changes in this version include:\r
99 \r
100 #if ($release.getActions('add').size() !=0)\r
101 New features:\r
102 #foreach($actionItem in $release.getActions('add'))\r
103 #processaction()\r
104 #end \r
105 #end\r
106 \r
107 #if ($release.getActions('fix').size() !=0)\r
108 Fixed Bugs:\r
109 #foreach($actionItem in $release.getActions('fix'))\r
110 #processaction()\r
111 #end\r
112 #end\r
113 \r
114 #if ($release.getActions('update').size() !=0)\r
115 Changes:\r
116 #foreach($actionItem in $release.getActions('update'))\r
117 #processaction()\r
118 #end\r
119 #end\r
120 \r
121 #if ($release.getActions('remove').size() !=0)\r
122 Removed:\r
123 #foreach($actionItem in $release.getActions('remove'))\r
124 #processaction()\r
125 #end\r
126 #end\r
127 ## End of main loop\r
128 #end\r
129 \r
130 Historical list of changes: ${project.url}changes-report.html\r
131 \r
132 For complete information on ${project.name}, including instructions on how to submit bug reports,\r
133 patches, or suggestions for improvement, see the Apache ${project.name} website:\r
134 \r
135 ${project.url}