This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit ca3faa21cbd75ee178d63264ea01753d8ef274c9 Author: Volkan Yazıcı <[email protected]> AuthorDate: Fri Sep 29 10:26:30 2023 +0200 Improve the docs on `author` --- src/site/_log4j-changelog.adoc | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/site/_log4j-changelog.adoc b/src/site/_log4j-changelog.adoc index d269405..b4b6235 100644 --- a/src/site/_log4j-changelog.adoc +++ b/src/site/_log4j-changelog.adoc @@ -132,7 +132,7 @@ A sample _changelog entry_ file is shared below. https://logging.apache.org/log4j/changelog-0.1.2.xsd"; type="fixed"> <issue id="LOG4J2-3556" link="https://issues.apache.org/jira/browse/LOG4J2-3556"/> - <author id="vy"/> + <author id="github:vy"/> <author name="Arthur Gavlyukovskiy"/> <description format="asciidoc"> Make `JsonTemplateLayout` stack trace truncation operate for each label block @@ -149,9 +149,15 @@ Some remarks about the structure of changelog entry files: ** `deprecated` – for soon-to-be removed features ** `removed` – for now removed features ** `fixed` – for any bug fixes -* `issue` element is optional, and, if present, must contain `id` and `link` attributes -* `author` element must have at least one of `id` or `name` attributes -* There must be at least one `author` +* `issue` element is optional, can occur multiple times, and, if present, must contain `id` and `link` attributes +* `author` element is optional, can occur multiple times, and, if present, must have at least one of `id` or `name` attributes ++ +[WARNING] +==== +The usage of `author` is mostly discouraged. +It is yet another bit to maintain and creates role-related (who did what) problems. +Many modern software projects are developed using a VCS (e.g., Git) and supporting services (e.g., GitHub) which make it trivial to trace back the origin of a change using commit and issue IDs. +==== * There must be a single `description` element with non-blank content and `format` attribute [#log4j-changelog-export]
