Add a changes.xml file to track resolved issues, along with a template that can be used to generate a release log file. To be able to generate a release log we need to also update commons-parent, which will be done later.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/logging/trunk@1374846 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dennis Lundberg
67
src/changes/changes.xml
Normal file
67
src/changes/changes.xml
Normal file
@@ -0,0 +1,67 @@
|
||||
<?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>Release Notes</title>
|
||||
</properties>
|
||||
<body>
|
||||
<release version="1.1.2" date="In SVN" description="Bug fixes.">
|
||||
<action type="fix" issue="LOGGING-130">
|
||||
Potential missing privileged block for class loader.
|
||||
</action>
|
||||
<action type="fix" issue="LOGGING-145">
|
||||
LogFactoryImpl.setAttribute - possible NPE.
|
||||
</action>
|
||||
<action type="fix" issue="LOGGING-142">
|
||||
Log4JLogger uses deprecated static members of Priority such as INFO.
|
||||
</action>
|
||||
<action type="fix" issue="LOGGING-128">
|
||||
Static analysis suggests a number of potential improvements.
|
||||
</action>
|
||||
<action type="fix" issue="LOGGING-147">
|
||||
SimpleLog.log - unsafe update of shortLogName.
|
||||
</action>
|
||||
<action type="fix" issue="LOGGING-148">
|
||||
LogFactory.diagnosticPrefix and diagnosticsStream could be final.
|
||||
</action>
|
||||
</release>
|
||||
</body>
|
||||
</document>
|
||||
109
src/changes/release-notes.vm
Normal file
109
src/changes/release-notes.vm
Normal file
@@ -0,0 +1,109 @@
|
||||
## 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.
|
||||
##
|
||||
Apache ${project.name} ${version} RELEASE NOTES
|
||||
|
||||
The ${developmentTeam} is pleased to announce the release of ${finalName}
|
||||
|
||||
$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","
|
||||
"))
|
||||
## 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
|
||||
#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}
|
||||
Reference in New Issue
Block a user