From 4dc73fc246fbfdfa2b74606b990bbe3e9288b195 Mon Sep 17 00:00:00 2001 From: Evan Sims Date: Mon, 1 Apr 2024 13:37:32 -0500 Subject: [PATCH] docs: update supported release details --- README.md | 43 ++++++++++++++++++++++++++++++++++++------- docs/Installation.md | 11 +---------- docs/Support.md | 43 ++++++++++++++++++++++++++++++++++++------- 3 files changed, 73 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 7dfa40d..c25f3bc 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,45 @@ ## Requirements -Your application must use the [latest supported Laravel version](https://endoflife.date/laravel), and your host environment must be running a [supported PHP version](https://www.php.net/supported-versions.php). Please review [our support policy](./docs/Support.md) for more information. +Your application must use a [supported Laravel version](#supported-laravel-releases), and your host environment must be running a [maintained PHP version](https://www.php.net/supported-versions.php). Please review [our support policy](./docs/Support.md) for more information. -| SDK | Laravel | PHP | Supported Until | -| ----- | ---------------------------------------------- | ---------------------------------------------- | --------------- | -| 7.13+ | [11.x](https://laravel.com/docs/11.x/releases) | [8.3](https://www.php.net/releases/8.3/en.php) | ~Sep 2025 | -| | | [8.2](https://www.php.net/releases/8.2/en.php) | ~Sep 2025 | +You will also need [Composer](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). -Due to breaking changes in Laravel 11, SDK 7.12 was the last version to support Laravel 9 and 10. +### Supported Laravel Releases -You will also need [Composer](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). +The next major release of Laravel is forecasted for Q1 2025. We anticipate supporting it upon release. + +| Laravel | SDK | PHP | Supported Until | +| ---------------------------------------------- | ----- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| [11.x](https://laravel.com/docs/11.x/releases) | 7.13+ | [8.3](https://www.php.net/releases/8.3/en.php) | Approx. [March 2026](https://laravel.com/docs/11.x/releases#support-policy) (EOL for Laravel 11) | +| | | [8.2](https://www.php.net/releases/8.2/en.php) | Approx. [Dec 2025](https://www.php.net/supported-versions.php) (EOL for PHP 8.2) | + +We strive to support all actively maintained Laravel releases, prioritizing support for the latest major version with our SDK. If a new Laravel major introduces breaking changes, we may have to end support for past Laravel versions earlier than planned. + +Affected Laravel versions will still receive security fixes until their end-of-life date, as announced in our release notes. + +### Maintenance Releases + +The following releases are no longer being updated with new features by Auth0, but will continue to receive security updates through their end-of-life date. + +| Laravel | SDK | PHP | Security Fixes Until | +| ---------------------------------------------- | ---------- | ---------------------------------------------- | -------------------------------------------------------------------------------------- | +| [10.x](https://laravel.com/docs/10.x/releases) | 7.5 - 7.12 | [8.3](https://www.php.net/releases/8.3/en.php) | [Feb 2025](https://laravel.com/docs/10.x/releases#support-policy) (EOL for Laravel 10) | +| | | [8.2](https://www.php.net/releases/8.2/en.php) | [Feb 2025](https://laravel.com/docs/10.x/releases#support-policy) (EOL for Laravel 10) | +| | | [8.1](https://www.php.net/releases/8.2/en.php) | [Nov 2024](https://www.php.net/supported-versions.php) (EOL for PHP 8.1) | + +### Unsupported Releases + +The following releases are unsupported by Auth0. While they may be suitable for some legacy applications, your mileage may vary. We recommend upgrading to a supported version as soon as possible. + +| Laravel | SDK | +| -------------------------------------------- | ---------- | +| [9.x](https://laravel.com/docs/9.x/releases) | 7.0 - 7.12 | +| [8.x](https://laravel.com/docs/8.x/releases) | 7.0 - 7.4 | +| [7.x](https://laravel.com/docs/7.x/releases) | 5.4 - 6.5 | +| [6.x](https://laravel.com/docs/6.x/releases) | 5.3 - 6.5 | +| [5.x](https://laravel.com/docs/5.x/releases) | 2.0 - 6.1 | +| [4.x](https://laravel.com/docs/4.x/releases) | 1.x | ## Getting Started diff --git a/docs/Installation.md b/docs/Installation.md index 7b537ed..15808f5 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -14,16 +14,7 @@ ## Prerequisites -Your application must use the [latest supported Laravel version](https://endoflife.date/laravel), and your host environment must be running a [supported PHP version](https://www.php.net/supported-versions.php). Please review [our support policy](./docs/Support.md) for more information. - -| SDK | Laravel | PHP | Supported Until | -| ----- | ---------------------------------------------- | ---------------------------------------------- | --------------- | -| 7.13+ | [11.x](https://laravel.com/docs/11.x/releases) | [8.3](https://www.php.net/releases/8.3/en.php) | ~Sep 2025 | -| | | [8.2](https://www.php.net/releases/8.2/en.php) | ~Sep 2025 | - -Due to breaking changes in Laravel 11, SDK 7.12 was the last version to support Laravel 9 and 10. - -You will also need [Composer 2.0+](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). +Your application must use the [latest supported Laravel version](https://endoflife.date/laravel), and your host environment must be running a [supported PHP version](https://www.php.net/supported-versions.php). Please review [our support policy](./docs/Support.md) for more information. You will also need [Composer 2.0+](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). ## Install the SDK diff --git a/docs/Support.md b/docs/Support.md index 97352be..7a1251b 100644 --- a/docs/Support.md +++ b/docs/Support.md @@ -1,15 +1,44 @@ # Support -To integrate our SDK, your application must use the [latest supported Laravel version](https://endoflife.date/laravel), and your environment must run a [supported PHP version](https://www.php.net/supported-versions.php). We do not support versions of either that are no longer supported by their maintainers. +Your application must use a [supported Laravel version](#supported-laravel-releases), and your host environment must be running a [maintained PHP version](https://www.php.net/supported-versions.php). -| SDK | Laravel | PHP | Supported Until | -| ----- | ---------------------------------------------- | ---------------------------------------------- | --------------- | -| 7.13+ | [11.x](https://laravel.com/docs/11.x/releases) | [8.3](https://www.php.net/releases/8.3/en.php) | ~Sep 2025 | -| | | [8.2](https://www.php.net/releases/8.2/en.php) | ~Sep 2025 | +You will also need [Composer](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). -Due to breaking changes in Laravel 11, SDK 7.12 was the last version to support Laravel 9 and 10. +### Supported Laravel Releases -You will also need [Composer 2.0+](https://getcomposer.org/) and an [Auth0 account](https://auth0.com/signup). +The next major release of Laravel is forecasted for Q1 2025. We anticipate supporting it upon release. + +| Laravel | SDK | PHP | Supported Until | +| ---------------------------------------------- | ----- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| [11.x](https://laravel.com/docs/11.x/releases) | 7.13+ | [8.3](https://www.php.net/releases/8.3/en.php) | Approx. [March 2026](https://laravel.com/docs/11.x/releases#support-policy) (EOL for Laravel 11) | +| | | [8.2](https://www.php.net/releases/8.2/en.php) | Approx. [Dec 2025](https://www.php.net/supported-versions.php) (EOL for PHP 8.2) | + +We strive to support all actively maintained Laravel releases, prioritizing support for the latest major version with our SDK. If a new Laravel major introduces breaking changes, we may have to end support for past Laravel versions earlier than planned. + +Affected Laravel versions will still receive security fixes until their end-of-life date, as announced in our release notes. + +### Maintenance Releases + +The following releases are no longer being updated with new features by Auth0, but will continue to receive security updates through their end-of-life date. + +| Laravel | SDK | PHP | Security Fixes Until | +| ---------------------------------------------- | ---------- | ---------------------------------------------- | -------------------------------------------------------------------------------------- | +| [10.x](https://laravel.com/docs/10.x/releases) | 7.5 - 7.12 | [8.3](https://www.php.net/releases/8.3/en.php) | [Feb 2025](https://laravel.com/docs/10.x/releases#support-policy) (EOL for Laravel 10) | +| | | [8.2](https://www.php.net/releases/8.2/en.php) | [Feb 2025](https://laravel.com/docs/10.x/releases#support-policy) (EOL for Laravel 10) | +| | | [8.1](https://www.php.net/releases/8.2/en.php) | [Nov 2024](https://www.php.net/supported-versions.php) (EOL for PHP 8.1) | + +### Unsupported Releases + +The following releases are unsupported by Auth0. While they may be suitable for some legacy applications, your mileage may vary. We recommend upgrading to a supported version as soon as possible. + +| Laravel | SDK | +| -------------------------------------------- | ---------- | +| [9.x](https://laravel.com/docs/9.x/releases) | 7.0 - 7.12 | +| [8.x](https://laravel.com/docs/8.x/releases) | 7.0 - 7.4 | +| [7.x](https://laravel.com/docs/7.x/releases) | 5.4 - 6.5 | +| [6.x](https://laravel.com/docs/6.x/releases) | 5.3 - 6.5 | +| [5.x](https://laravel.com/docs/5.x/releases) | 2.0 - 6.1 | +| [4.x](https://laravel.com/docs/4.x/releases) | 1.x | ## Support Policy