Repository navigation
docs: document versioning and support policy #2332
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.
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
Draft
aidan-casey
wants to merge
1
commit into
3.x
Choose a base branch
from
add-version-info
base: 3.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Versions & Support | ||
|
|
||
| Tempest follows a straightforward versioning and support policy. We focus our maintenance efforts on the latest stable major version, embrace modern PHP features, and provide automated upgrade paths to help projects stay up to date. | ||
|
|
||
| ## Supported versions | ||
|
|
||
| Only the latest stable major version of Tempest is officially supported. | ||
|
|
||
| | Version | Status | Support | | ||
| |---|---|---| | ||
| | 4.x | Upcoming | Not yet released | | ||
| | 3.x | Current | Supported | | ||
| | 2.x and older | End of life | Unsupported | | ||
|
|
||
| When a new major version is released, the previous major version reaches its end of life and no longer receives official support. | ||
|
|
||
| This means that when Tempest 4.x is released, Tempest 3.x will no longer be supported. | ||
|
|
||
| ## Long-term support | ||
|
|
||
| Tempest does not offer long-term support (LTS) releases. | ||
|
|
||
| Instead of maintaining multiple major versions simultaneously, we focus our efforts on improving and maintaining the latest version of the framework. | ||
|
|
||
| This allows us to move the framework forward without the maintenance burden of supporting older versions indefinitely. | ||
|
|
||
| We encourage developers to stay up to date with the latest stable major version. | ||
|
|
||
| ## PHP version support | ||
|
|
||
| Tempest embraces modern PHP and aims to make full use of the language's latest features and improvements. | ||
|
|
||
| **The latest major version of Tempest targets the latest stable version of PHP.** We prioritize moving the framework forward rather than maintaining compatibility with older PHP versions. | ||
|
|
||
| As a result, upgrading to a new major version of Tempest may also require upgrading your PHP version. | ||
|
|
||
| We believe staying current with PHP allows us to build a simpler, more expressive, and more maintainable framework. | ||
|
|
||
| You can find the exact PHP requirements for your version of Tempest in the installation documentation. | ||
|
|
||
| ## What does support include? | ||
|
|
||
| Supported versions may receive: | ||
|
|
||
| - Bug fixes | ||
| - Security fixes | ||
| - Compatibility updates | ||
| - General maintenance and improvements | ||
|
|
||
| Unsupported versions no longer receive official maintenance, including bug fixes and security updates. | ||
|
|
||
| We do not guarantee specific support periods or security response times. | ||
|
|
||
| ## Upgrading between versions | ||
|
|
||
| We understand that upgrading between major versions can require changes to your application. | ||
|
|
||
| To make upgrades easier, **Tempest provides [Rector](https://getrector.com/) suites** that automate many of the changes required when moving between major versions. | ||
|
|
||
| Our goal is to make upgrading as straightforward as possible, allowing developers to adopt new versions without having to manually address every breaking change. | ||
|
|
||
| While Rector can automate many changes, some upgrades may still require manual adjustments. We recommend reviewing the changes and running your application's test suite after upgrading. | ||
|
|
||
| ## Which version should I use? | ||
|
|
||
| For new projects, we always recommend using the latest stable major version of Tempest alongside the latest stable version of PHP. | ||
|
|
||
| For existing projects, we recommend keeping both Tempest and PHP up to date to benefit from security fixes, performance improvements, and new language features. | ||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.