ppkarwasz commented on code in PR #3341: URL: https://github.com/apache/logging-log4j2/pull/3341#discussion_r2592614043
########## src/site/antora/modules/ROOT/pages/versioning.adoc: ########## @@ -0,0 +1,156 @@ +//// + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +//// + += Versioning and support policy + +== Versioning + +Apache Log4j releases follow the +https://semver.org/spec/v2.0.0.html[Semantic Versioning specification], which means that the release numbering is of the form: + +[source] +---- +<major>.<minor>.<patch>[-<pre-release>] +---- + +where: + +<major>:: ++ +Is the major version number. +This number is incremented when **breaking changes** are introduced to the software. ++ +Upgrading to a new major release might require code changes. +See +xref:migrate-from-log4j1.adoc[] +to migrate from Log4j 1 to Log4j 2. + +<minor>:: ++ +Is the minor version number. +This number is incremented each time: ++ +-- +* A new Java method/class appears in the public API of one of the +xref:components.adoc[Log4j artifacts]. +* A new configuration attribute is added to one of the +xref:manual/plugins.adoc[Log4j Plugins (appenders, layouts, filters, etc.)]. +* A functionality or Java method/class are deprecated. +* A behavioral change is introduced. +-- ++ +When upgrading to a new minor version, check the +xref:release-notes.adoc[] +of the new minor version: behavioral changes are highlighted in the release description and contained in the "Changed" section. + +<patch>:: ++ +Is the patch release number. +This number is incremented if the release only contains bug fixes. ++ +Upgrading to a new patch release constitutes the easiest upgrade path. ++ +[NOTE] +==== +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 Review Comment: Fixed in https://github.com/apache/logging-log4j2/pull/3341/commits/6b97d3d8ad73e121409054bd97e2da81f716f8bc -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
