Skip to content

[docs] Add EOL table to documentation #715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 14, 2020
Merged

[docs] Add EOL table to documentation #715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15b419f
docs: remove old changelog
bmorelli25 Feb 13, 2020
01314c0
docs: add EOL table
bmorelli25 Feb 13, 2020
e317e53
docs: docs for the docs
bmorelli25 Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CHANGELOG.md
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ If you have commit access, the process is as follows:

1. Update the version in `elasticapm/version.py` according to the scale of the change. (major, minor or patch)
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`.
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.
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`
1. Tag the commit with `git tag -a vX.Y.Z`, for example `git tag -a v1.2.3`.
Copy the changelog for the release to the tag message, removing any leading `#`.
Expand Down
20 changes: 20 additions & 0 deletions docs/upgrading.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,26 @@ Upgrades that involve a major version bump often come with some backwards incomp
We highly recommend to always pin the version of `elastic-apm` in your `requirements.txt` or `Pipfile`.
This avoids automatic upgrades to potentially incompatible versions.

[float]
[[end-of-life-dates]]
=== End of life dates

We love all our products, but sometimes we must say goodbye to a release so that we can continue moving
forward on future development and innovation.
Our https://www.elastic.co/support/eol[End of life policy] defines how long a given release is considered supported,
as well as how long a release is considered still in active development or maintenance.
The table below is a simplified description of this policy.

[options="header"]
|====
|Agent version |EOL Date |Maintained until
|1.x |2019-06-11 |2.0
|2.x |2019-08-06 |3.0
|3.x |2020-01-20 |4.0
|4.x |2020-05-14 |5.0
|5.x |2021-02-05 |6.0
|====

[[upgrading-5.x]]
=== Upgrading to version 5 of the agent

Expand Down