Skip to content

Commit 3395d8e

Browse files
FreeAndNilFreeAndNil
authored
Add versioning and support policy information (#275)
1 parent 0fcf403 commit 3395d8e

File tree

5 files changed

+181
-0
lines changed

5 files changed

+181
-0
lines changed

‎antora-playbook.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,10 @@ ui:
101101
.hljs-string {
102102
color: #0f8532;
103103
}
104+
/* Colors for maintenance policies */
105+
.development { color: #8A4FFF; }
106+
.active { color: #28A745; }
107+
.eol { color: #DC3545; }
104108
</style>
105109
106110
- path: partials/header-content.hbs

‎src/site/antora/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@
4848
* xref:release-notes.adoc[]
4949
* xref:release-review.adoc[]
5050
* {logging-services-url}/support.html[Support]
51+
** xref:versioning.adoc[]
5152
* {logging-services-url}/security.html[Security]

‎src/site/antora/modules/ROOT/pages/download.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ Proceed to xref:manual/installation.adoc[].
2828
Proceed to xref:release-notes.adoc[].
2929
====
3030
31+
include::partial$supported-versions.adoc[leveloffset=+1]
32+
33+
See xref:versioning.adoc[Version lifecycle and maintenance policy] for more information about the maintenance lifecycle of log4net versions.

‎src/site/antora/modules/ROOT/pages/versioning.adoc‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
////
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
////
17+
18+
= Versioning and support policy
19+
20+
include::partial$supported-versions.adoc[leveloffset=+1]
21+
22+
23+
[#versioning-policy]
24+
== Versioning policy
25+
26+
Apache log4net follows
27+
https://semver.org/spec/v2.0.0.html[semantic versioning],
28+
with release numbers of the form:
29+
30+
[source]
31+
----
32+
<major>.<minor>.<patch>[-<pre-release>]
33+
----
34+
35+
where:
36+
37+
<major>::
38+
+
39+
The major version number is incremented when **breaking changes** are introduced.
40+
+
41+
Upgrading to a new major version typically requires code changes in your application.
42+
For each new major release, a migration guide will be provided.
43+
+
44+
45+
<minor>::
46+
+
47+
The minor version number is incremented when new features are added in a backward-compatible manner, such as:
48+
+
49+
--
50+
* New methods or classes added to the public API of one of the components.
51+
* New configuration attributes added to appenders, layouts, filters, etc.
52+
* Functionality or methods/classes being deprecated.
53+
* Behavioral changes introduced without breaking the public API.
54+
--
55+
+
56+
Upgrading to a new minor version usually does not require code changes,
57+
unless you rely on undocumented behavior that has changed.
58+
To avoid accumulating such changes, we recommend upgrading minor versions regularly.
59+
+
60+
When upgrading to a new minor version, review the corresponding
61+
xref:release-notes.adoc[]:
62+
behavioral changes are highlighted in the release description and listed in the “Changed” section.
63+
64+
<patch>::
65+
+
66+
The patch version number is incremented when only backward-compatible bug fixes are introduced.
67+
+
68+
Upgrading to a new patch release is the simplest upgrade path.
69+
+
70+
[NOTE]
71+
====
72+
The classification of a behavioral change as a minor or patch release may vary by interpretation:
73+
what is considered a bug by one user may be viewed as a feature by another.
74+
====
75+
76+
[#maintenance-policy]
77+
== Version lifecycle and maintenance policy
78+
79+
Minor releases of Apache log4net follow a defined lifecycle consisting of three phases:
80+
81+
[development]#Active development#::
82+
+
83+
The version is under active development and may introduce new features.
84+
Preview builds may be published during this phase; vulnerability reports are accepted and will be addressed.
85+
+
86+
Versions in this phase are **not recommended** for production use.
87+
88+
[active]#Active maintenance#::
89+
+
90+
The version is considered stable and suitable for production.
91+
Vulnerability reports are accepted and will be addressed.
92+
+
93+
Due to the limited resources of the Apache log4net project, **only the latest minor release of the latest major version** remains in Active.
94+
95+
[eol]#End-of-life (EOL)#::
96+
+
97+
The version is no longer maintained, and **vulnerability reports are not accepted**.
98+
+
99+
We will notice the end of support for a version when the first preview for a new major version is published.
100+
+
101+
[cols="3h,1,1,1"]
102+
|===
103+
| Maintenance phase | New features | Security/bug fixes | Security advisories
104+
105+
| [development]#Active development#
106+
| **Yes**
107+
| **Yes**
108+
| **Yes**
109+
110+
| [development]#Active maintenance#
111+
| **Yes**
112+
| **Yes**
113+
| **Yes**
114+
115+
| [eol]#End-of-life (EOL)#
116+
| No
117+
| No
118+
| No
119+
120+
|===
121+
122+
[NOTE]
123+
====
124+
We avoid using the term *support* to describe the maintenance phases, because
125+
support remains available in **all** phases:
126+
127+
* See {logging-services-url}/support.html#discussions-user[Community support]
128+
for the community-run discussion channels that are offered on a best-effort basis.
129+
* Although the ASF does not endorse any third-party commercial providers,
130+
some companies may offer paid support for EOM or EOL versions.
131+
See {logging-services-url}/support.html#commercial[Commercial support]
132+
for a publicly maintained list of such providers.
133+
====

‎src/site/antora/modules/ROOT/partials/supported-versions.adoc‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
////
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
////
17+
18+
[#supported-versions]
19+
= Supported versions
20+
21+
.Maintenance status of selected log4net versions
22+
[cols="2h,2,3,2,2,4"]
23+
|===
24+
| Version | Status | Latest release | First release | End-of-life | Notes
25+
26+
| 3.x
27+
| **[active]#Active#**
28+
| 3.2.0
29+
| 2024-09-12
30+
|
31+
|
32+
33+
| 2.x
34+
| **[eol]#End-of-life#**
35+
| 2.0.17
36+
| 2020-09-06
37+
| 2024-09-12
38+
| Last release to support net20 and net45
39+
40+
|===

0 commit comments

Comments
 (0)