Add versioning and support policy information #3341
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds information about the support status of various Apache Log4j releases. Related to #1867
vy
requested changes
Jan 2, 2025
| The classification of behavioral changes as minor or patch release is up to interpretation: what constitutes a bug for one user might be a feature for somebody else. | ||
| ==== | ||
|
|
||
| === OSGi package versioning |
There was a problem hiding this comment.
Can we make this subsection collapsible, please?
|
|
||
| Since release `2.21.0` Log4j follows the OSGi practice of versioning each Java package separately (see | ||
| https://bnd.bndtools.org/chapters/170-versioning.html#versioning-packages[Versioning Packages] for more information). | ||
| The version of each package is available in the manifests of each artifact and in the Javadoc of each package: e.g. the version of the `o.a.l.l.core.appender` package is available in the |
There was a problem hiding this comment.
Suggested change
| The version of each package is available in the manifests of each artifact and in the Javadoc of each package: e.g. the version of the `o.a.l.l.core.appender` package is available in the | |
| The version of each package is available in the manifests of each artifact and in the Javadoc of each package: e.g. the version of the `org.apache.logging.log4j.core.appender` package is available in the |
|
|
||
| == Support policy | ||
|
|
||
| Apache Log4j currently supports two versions: Apache Log4j 2.x and the incubating Apache Log4j Core 3.x as in the table below: |
There was a problem hiding this comment.
I am okay with 2.x, 3.x, etc. usages in the table below. Yet, IMHO, we should stick to Log4j 2, Log4j 3 in the text.
Suggested change
| Apache Log4j currently supports two versions: Apache Log4j 2.x and the incubating Apache Log4j Core 3.x as in the table below: | |
| Apache Log4j currently supports two versions: Apache Log4j 2 and the incubating Apache Log4j Core 3 as in the table below: |
| + | ||
| The version is under active development. | ||
|
|
||
| EOS:: |
There was a problem hiding this comment.
Suggested change
| EOS:: | |
| End-of-Support (EOS):: |
| The version will not receive any updates, including security updates. | ||
| New security advisories against this version might be published in the future. | ||
|
|
||
| EOL:: |
There was a problem hiding this comment.
Suggested change
| EOL:: | |
| End-of-Life (EOL):: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds information about the support status of various Apache Log4j releases.
Related to #1867