Prepare for release
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
index af0c9e1..67feafc 100644
--- a/RELEASE-NOTES.md
+++ b/RELEASE-NOTES.md
@@ -1,17 +1,44 @@
-# Apache Log4j Audit 1.0.0 Release Notes
+# Apache Log4j 1.0.1 Release Notes
-This is the initial release of Log4j Audit.
+The Apache Log4j Audit team is pleased to announce the Log4j Audit 1.0.1 release!
-## GA Release 1.0.0
+Apache Log4j Audit is a framework for performing audit logging using a predefined catalog of audit events. It
+provides a tool to create and edit audit events. It also provides a REST service to perform the logging so
+that non-Java applications can use a common auditing facility.
+
+## Release 1.0.1
Changes in this version include:
+### Fixed Bugs
+* [LOG4J2-2428](https://issues.apache.org/jira/browse/LOG4J2-2428):
+Use the AuditExceptionHandler for validation exceptions. Thanks to Andrei Ivanov.
+* [LOG4J2-2443](https://issues.apache.org/jira/browse/LOG4J2-2443):
+Fix inconsistencies in validation exceptions. Thanks to Andrei Ivanov.
+* [LOG4J2-2440](https://issues.apache.org/jira/browse/LOG4J2-2440):
+AuditEvents should provide some basic toString(). Thanks to Andrei Ivanov.
+* [LOG4J2-2429](https://issues.apache.org/jira/browse/LOG4J2-2429):
+Setting the exceptionHandler on the AuditEvent sets it as a ThreadContext variable. Thanks to Andrei Ivanov.
+* [LOG4J2-2421](https://issues.apache.org/jira/browse/LOG4J2-2421):
+Add verbose parameter to the Log4j audit Maven plugin. Thanks to Andrei Ivanov.
+* [LOG4J2-2421](https://issues.apache.org/jira/browse/LOG4J2-2421):
+AbstractEventLogger.logEvent doesn't check for missing required context attributes. Thanks to Andrei Ivanov.
+* [LOG4J2-2417](https://issues.apache.org/jira/browse/LOG4J2-2417):
+Better handling of optional properties. Thanks to Andrei Ivanov.
+* [LOG4J2-2420](https://issues.apache.org/jira/browse/LOG4J2-2420):
+RequestContextFilter logging cleanup. Thanks to Andrei Ivanov.
+* [LOG4J2-2442](https://issues.apache.org/jira/browse/LOG4J2-2442):
+Normalize the event names logged through AbstractEventLogger.logEvent. Thanks to Andrei Ivanov.
+* [LOG4J2-2431](https://issues.apache.org/jira/browse/LOG4J2-2431):
+Narrow the return type of getEvent. Thanks to Andrei Ivanov.
+
+
---
-Apache Log4j Audit 1.0.0 requires a minimum of Java 8 to build and run.
+Apache Log4j Audit 1.0.1 requires a minimum of Java 8 to build and run.
For complete information on Apache Log4j Audit, including instructions on how to submit bug
reports, patches, or suggestions for improvement, see the Apache Apache Log4j Audit website:
-https://logging.apache.org/log4j-audit/
\ No newline at end of file
+http://logging.apache.org/log4j-audit
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index dd4bfa6..32a07b5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -108,7 +108,7 @@
<log4jParentDir>${basedir}</log4jParentDir>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.javadoc.failOnError>false</maven.javadoc.failOnError>
- <Log4jAuditVersion>1.0.0</Log4jAuditVersion>
+ <Log4jAuditVersion>1.0.1</Log4jAuditVersion>
<Log4jReleaseManager>Ralph Goers</Log4jReleaseManager>
<Log4jReleaseKey>B3D8E1BA</Log4jReleaseKey>
<antlr.version>2.7.7</antlr.version>
@@ -1198,7 +1198,7 @@
<templateDirectory>src/changes</templateDirectory>
<runOnlyAtExecutionRoot>true</runOnlyAtExecutionRoot>
<announcementDirectory>.</announcementDirectory>
- <announcementFile>RELEASE-NOTES.txt</announcementFile>
+ <announcementFile>RELEASE-NOTES.md</announcementFile>
<issueManagementSystems>
<issueManagementSystem>changes.xml</issueManagementSystem>
<!--<issueManagementSystem>JIRA</issueManagementSystem> -->
diff --git a/src/changes/announcement.vm b/src/changes/announcement.vm
index 1d11b6a..7317640 100644
--- a/src/changes/announcement.vm
+++ b/src/changes/announcement.vm
@@ -22,17 +22,17 @@
#macro(formatAction $item)
## Use replaceAll to fix up LF-only line ends on Windows.
## Also replace < and > with entity versions to avoid HTML being misinterpreted.
- #set($action=$item.action.replaceAll("\n","
+#set($action=$item.action.replaceAll("\n","
").replaceAll("<", "<").replaceAll(">", ">"))
- #if($item.issue)
- #set($issue = $item.issue)
- #set($url = "https://issues.apache.org/jira/browse/$issue")
- #else
- #set($issue = "")
- #end
+#if($item.issue)
+#set($issue = $item.issue)
+#set($url = "https://issues.apache.org/jira/browse/$issue")
+#else
+#set($issue = "")
+#end
* #if($issue)[$issue]($url):#end
- ${action}#if($item.dueTo) Thanks to ${item.dueTo}.#end
+${action}#if($item.dueTo) Thanks to ${item.dueTo}.#end
#end
## -----------------------------------------
@@ -40,7 +40,9 @@
The ${developmentTeam} is pleased to announce the Log4j Audit ${relVersion} release!
-Apache Log4j Audit is a framework for performing
+Apache Log4j Audit is a framework for performing audit logging using a predefined catalog of audit events. It
+provides a tool to create and edit audit events. It also provides a REST service to perform the logging so
+that non-Java applications can use a common auditing facility.
## Hack to improve layout: replace all pairs of spaces with a single new-line
$h2 $release.description.replaceAll(" ", "
@@ -51,33 +53,33 @@
#else
Changes in this version include:
- #if ($release.getActions('add').size() !=0)
- $h3 New Features
- #foreach($actionItem in $release.getActions('add'))
- #formatAction($actionItem)
- #end
- #end
+#if ($release.getActions('add').size() !=0)
+$h3 New Features
+#foreach($actionItem in $release.getActions('add'))
+#formatAction($actionItem)
+#end
+#end
- #if ($release.getActions('fix').size() !=0)
- $h3 Fixed Bugs
- #foreach($actionItem in $release.getActions('fix'))
- #formatAction($actionItem)
- #end
- #end
+#if ($release.getActions('fix').size() !=0)
+$h3 Fixed Bugs
+#foreach($actionItem in $release.getActions('fix'))
+#formatAction($actionItem)
+#end
+#end
- #if ($release.getActions('update').size() !=0)
- $h3 Changes
- #foreach($actionItem in $release.getActions('update'))
- #formatAction($actionItem)
- #end
- #end
+#if ($release.getActions('update').size() !=0)
+$h3 Changes
+#foreach($actionItem in $release.getActions('update'))
+#formatAction($actionItem)
+#end
+#end
- #if ($release.getActions('remove').size() !=0)
- $h3 Removed
- #foreach($actionItem in $release.getActions('remove'))
- #formatAction($actionItem)
- #end
- #end
+#if ($release.getActions('remove').size() !=0)
+$h3 Removed
+#foreach($actionItem in $release.getActions('remove'))
+#formatAction($actionItem)
+#end
+#end
## End of main loop
#end
---
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 79c7a2e..17cdabc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -30,7 +30,7 @@
- "update" - Change
- "remove" - Removed
-->
- <release version="1.0.1" date="YYYY-MM-DD" description="Release 1.0.1">
+ <release version="1.0.1" date="2018-12-2" description="Release 1.0.1">
<action issue="LOG4J2-2428" dev="rgoers" type="fix" due-to="Andrei Ivanov">
Use the AuditExceptionHandler for validation exceptions.
</action>
