Skip to content

Commit 151f2ef

Browse files
authored
[docs] Add EOL table to documentation (#715)
1 parent eca7947 commit 151f2ef

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ If you have commit access, the process is as follows:
102102

103103
1. Update the version in `elasticapm/version.py` according to the scale of the change. (major, minor or patch)
104104
1. Update `CHANGELOG.asciidoc`. Rename the `Unreleased` section to the correct version (`vX.X.X`), and nest under the appropriate sub-heading, e.g., `Python Agent version 5.x`.
105+
1. For Majors: Add a new row to the EOL table in `docs/upgrading.asciidoc`. The EOL date is the release date plus 18 months.
105106
1. Commit changes with message `update CHANGELOG and bump version to X.Y.Z` where `X.Y.Z` is the version in `elasticapm/version.py`
106107
1. Tag the commit with `git tag -a vX.Y.Z`, for example `git tag -a v1.2.3`.
107108
Copy the changelog for the release to the tag message, removing any leading `#`.

docs/upgrading.asciidoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,26 @@ Upgrades that involve a major version bump often come with some backwards incomp
77
We highly recommend to always pin the version of `elastic-apm` in your `requirements.txt` or `Pipfile`.
88
This avoids automatic upgrades to potentially incompatible versions.
99

10+
[float]
11+
[[end-of-life-dates]]
12+
=== End of life dates
13+
14+
We love all our products, but sometimes we must say goodbye to a release so that we can continue moving
15+
forward on future development and innovation.
16+
Our https://www.elastic.co/support/eol[End of life policy] defines how long a given release is considered supported,
17+
as well as how long a release is considered still in active development or maintenance.
18+
The table below is a simplified description of this policy.
19+
20+
[options="header"]
21+
|====
22+
|Agent version |EOL Date |Maintained until
23+
|1.x |2019-06-11 |2.0
24+
|2.x |2019-08-06 |3.0
25+
|3.x |2020-01-20 |4.0
26+
|4.x |2020-05-14 |5.0
27+
|5.x |2021-02-05 |6.0
28+
|====
29+
1030
[[upgrading-5.x]]
1131
=== Upgrading to version 5 of the agent
1232

0 commit comments

Comments
 (0)