Adapt the changelog to log4j-tools 0.3.0 release

Author: vy

CHANGELOG.adoc

@@ -15,63 +15,20 @@
     limitations under the License.
 ////
 
-:log4j-changelog-ref: https://github.com/apache/logging-log4j-tools/tree/master/log4j-changelog[log4j-changelog]
+:log4j-changelog-uri: https://github.com/apache/logging-log4j-tools/tree/master/log4j-changelog
+:log4j-changelog-ref: {log4j-changelog-uri}[log4j-changelog]
 
 == Where are changelogs stored?
 
 Changelogs are stored in xref:src/changelog[`src/changelog`] directory.
 
-{log4j-changelog-ref} is used to generate AsciiDoc-formatted changelog files during Maven `pre-site` phase and export them to xref:target/generated-sources/site/asciidoc/changelog[`target/generated-sources/site/asciidoc/changelog`] directory.
+{log4j-changelog-ref} is used to generate AsciiDoc-formatted release notes during Maven `pre-site` phase and export them to xref:target/generated-sources/site/asciidoc/changelog[`target/generated-sources/site/asciidoc/changelog`] directory.
 These exported AsciiDoc files are not committed, since they are only relevant for the website, and they cause merge-conflicts between feature branches.
 `./mvnw site` command can be used to manually generate these files.
 
 See {log4j-changelog-ref} project for further details; how to use this changelog system, what steps are needed while making a new release, etc.
 
-== I am about to deploy a new release. What shall I do?
+== How can I create a changelog entry?
 
-Just before a release, three things need to happen in the changelog sources:
-
-. *changelog entry files needs to be moved* from the _upcoming_ release changelog directory `src/changelog/.<releaseVersionMajor>.x.x`  to the _new_ release changelog directory `src/changelog/<releaseVersion>`
-. *`.changelog.adoc.ftl` needs to be copied* from the _upcoming_ release changelog directory to the _new_ release changelog directory, unless it already exists in the target
-. *`.release.xml` needs to be created* in the _new_ release changelog directory
-
-Due to the nature of release candidates, above steps might need to be repeated multiple times.
-
-[TIP]
-====
-Log4j _releases_ and _release candidates_ all get deployed to the same https://repository.apache.org/#stagingRepositories[_staging repository_].
-Their `pom.xml` files all contain the same release version, e.g., `2.19.0`.
-There are no `-rc1`, `-rc2`, etc. suffixes in the version of a release candidate.
-Once a release candidate voting reaches to a consensus for release, associated artifacts simply get promoted from the _staging_ to the _public_ repository.
-Hence, there are no differences between releases and release candidates.
-====
-
-How to carry out aforementioned changes are explained below in steps:
-
-. Populate the `src/changelog/<releaseVersion>` directory (e.g., `src/changelog/2.19.0`) from the upcoming release changelog directory (e.g., `src/changelog/.2.x.x`):
-+
-[source,bash]
-----
-./mvnw -N -P changelog-releaser
-----
-+
-[IMPORTANT]
-====
-`changelog-releaser` Maven profile obtains the new release version from `Log4jReleaseVersion` property.
-If needed, you can override it to point to another release version:
-
-[source,bash]
-----
-./mvnw -N -P changelog-releaser -DLog4jReleaseVersion=6.6.6
-----
-====
-. Verify that all changelog entry files are moved from `src/changelog/.<releaseVersionMajor>.x.x` directory (e.g., `src/changelog/.2.x.x`)
-. Verify that `src/changelog/<releaseVersion>` directory (e.g., `src/changelog/2.19.0`) is created, and it contains `.changelog.adoc.ftl`, `.release.xml`, and changelog entry files
-+
-[IMPORTANT]
-====
-If `src/changelog/<releaseVersion>` directory (e.g., `src/changelog/2.19.0`) already exists with certain content, `changelog-releaser` profile will only move new changelog entry files and override `.release.xml`; `.changelog.adoc.ftl` will not be touched, if it already exists.
-This allows one to run `changelog-releaser` profile multiple times, e.g., to incorporate changes added to a release candidate.
-====
-. Edit the populated `.changelog.adoc.ftl`
-. `git add` the changes in `src/changelog` and commit them
+For the impatient, simply copy one of the existing `<issueId>_<summary>.xml` files in xref:src/changelog/.2.x.x[`src/changelog/.2.x.x`] directory and adapt to your needs.
+See {log4j-changelog-uri}/README.adoc#changelog-entry-file[the official documentation] for details.

pom.xml

@@ -360,7 +360,7 @@
     <docker-maven-plugin.version>0.40.2</docker-maven-plugin.version>
     <exam-maven-plugin.version>4.13.5</exam-maven-plugin.version>
     <findsecbugs-plugin.version>1.12.0</findsecbugs-plugin.version>
-    <log4j-tools.version>0.2.0</log4j-tools.version>
+    <log4j-tools.version>0.3.0</log4j-tools.version>
     <maven-artifact-plugin.version>3.4.0</maven-artifact-plugin.version>
     <maven-bundle-plugin.version>5.1.8</maven-bundle-plugin.version>
     <maven-checkstyle-plugin.version>3.2.0</maven-checkstyle-plugin.version>
@@ -1768,6 +1768,17 @@
         <inherited>false</inherited>
         <configuration>
           <outputDirectory>${project.build.directory}/generated-sources/site/asciidoc/release-notes</outputDirectory>
+          <indexTemplates>
+            <template>
+              <source>.index.adoc.ftl</source>
+            </template>
+          </indexTemplates>
+          <changelogTemplates>
+            <template>
+              <source>.release-notes.adoc.ftl</source>
+              <target>%v.adoc</target>
+            </template>
+          </changelogTemplates>
         </configuration>
         <executions>
           <execution>