Skip to content

Commit

Permalink
Improve release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ppkarwasz committed Sep 17, 2024
1 parent 019d40e commit ddb4413
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 27 deletions.
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -959,6 +959,7 @@
<plugin>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-changelog-maven-plugin</artifactId>
<inherited>false</inherited>
<executions>
<execution>
<id>generate-changelog</id>
Expand Down
2 changes: 1 addition & 1 deletion src/antora/modules/ROOT/partials/release-notes/2.18.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ First release containing:
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextDataProv
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -95,8 +95,7 @@ https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextDataProv
[#release-notes-3-0-0-beta1-changed]
=== Changed
* Add Tomcat JULI implementation in artifact `log4j-tomcat-juli`. (https://github.com/copernik-eu/log4j-plugins/issues/101[#101])
* Add Tomcat JULI implementation in a new `tomcat-juli-to-log4j` artifact. (https://github.com/copernik-eu/log4j-plugins/issues/101[#101])
* Add a context data provider to fill the "engine.name", "host.name" and "context.name" context entries. (https://github.com/copernik-eu/log4j-plugins/issues/103[#103])
* Add context selector based on Tomcat's thread context classloaders. (https://github.com/copernik-eu/log4j-plugins/issues/105[#105])
* Split Tomcat lookup into a `log4j-tomcat-lookup` artifact. (https://github.com/copernik-eu/log4j-plugins/issues/80[#80])
* Added `org.apache.logging:logging-parent` as parent of the `log4j-plugins-parent`.
* Split Tomcat classloaders into a new `tomcat-log4j` artifact. (https://github.com/copernik-eu/log4j-plugins/issues/80[#80])
2 changes: 1 addition & 1 deletion src/antora/modules/ROOT/partials/release-notes/3.x.x.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This minor release contains several small improvements.
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions src/changelog/.3.x.x/.release-notes.adoc.ftl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -43,4 +43,4 @@

This minor release contains several small improvements.

<#include "../changelog.adoc.ftl">
<#include "../changelog.adoc.ftl">
4 changes: 2 additions & 2 deletions src/changelog/2.18.0/.release-notes.adoc.ftl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -46,4 +46,4 @@ First release containing:
* a Tomcat classloader that applies the "delegate to parent first" strategy to `log4j-api` classes,
* a Log4j Core lookup that resolves the name of the application currently running on the thread.

<#include "../changelog.adoc.ftl">
<#include "../changelog.adoc.ftl">
4 changes: 2 additions & 2 deletions src/changelog/3.0.0-beta1/.release-notes.adoc.ftl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -62,4 +62,4 @@ https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextSelector
* a
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextDataProvider[Tomcat context data provider].

<#include "../changelog.adoc.ftl">
<#include "../changelog.adoc.ftl">
2 changes: 1 addition & 1 deletion src/changelog/3.0.0-beta1/101_add_tomcat_juli.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
type="changed">
<issue id="101" link="https://github.com/copernik-eu/log4j-plugins/issues/101"/>
<description format="asciidoc">
Add Tomcat JULI implementation in artifact `log4j-tomcat-juli`.
Add Tomcat JULI implementation in a new `tomcat-juli-to-log4j` artifact.
</description>
</entry>
2 changes: 1 addition & 1 deletion src/changelog/3.0.0-beta1/80_split_artifacts.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
type="changed">
<issue id="80" link="https://github.com/copernik-eu/log4j-plugins/issues/80"/>
<description format="asciidoc">
Split Tomcat lookup into a `log4j-tomcat-lookup` artifact.
Split Tomcat classloaders into a new `tomcat-log4j` artifact.
</description>
</entry>
9 changes: 0 additions & 9 deletions src/changelog/3.0.0-beta1/changed_parent.xml

This file was deleted.

4 changes: 2 additions & 2 deletions src/changelog/changelog.adoc.ftl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -32,4 +32,4 @@
* ${entry.description.text?replace("\\s+", " ", "r")}<#if entry.issues?has_content> (<#list entry.issues as issue>${issue.link}[#${issue.id}]<#if issue?has_next>, </#if></#list>)</#if>
</#list>
</#list>
</#if>
</#if>
4 changes: 2 additions & 2 deletions src/changelog/index.adoc.ftl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
////
// tag::license[]
//
// Copyright © $YEAR Piotr P. Karwasz
// Copyright © 2024 Piotr P. Karwasz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -48,4 +48,4 @@ Hence, you must always
<#list releases as release><#if release.changelogEntryCount gt 0>

include::partial$release-notes/${release.version}.adoc[]
</#if></#list>
</#if></#list>

0 comments on commit ddb4413

Please sign in to comment.