-
-
Notifications
You must be signed in to change notification settings - Fork 401
Add ghc deprecation policy to documentation #2231
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
46d1a86
Create ghc-deprecation.md
jneira 97e4416
Mark 8.8.3 with *
jneira 567c961
Add deprecation to index
jneira 4c814a8
dont use bullet list for prose
jneira 764f414
Move ghc support plan
jneira 482695b
Rephrasing
jneira 7548954
Tweak support docs (#2232)
michaelpj da0b931
Include pepe suggestions
jneira d0884ad
More precisions
jneira 503bc7b
Merge branch 'master' into jneira-patch-1
jneira 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| haskell-language-server | ||
| ======================= | ||
|
|
||
| Integration point for `ghcide <https://github.com/haskell/ghcide>`_ and `haskell-ide-engine <https://github.com/haskell/haskell-ide-engine>`_. One IDE to rule | ||
| them all. Read the `project's background <https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html>`_. | ||
| Official haskell ide support via language server (LSP). Successor of `ghcide <https://github.com/haskell/ghcide>`_ and `haskell-ide-engine <https://github.com/haskell/haskell-ide-engine>`_. Read the `project's background <https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html>`_. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| features | ||
| installation | ||
| supported-versions | ||
| configuration | ||
| troubleshooting | ||
| contributing/index |
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,69 @@ | ||
| # Supported GHC versions | ||
|
|
||
| ## Current GHC version support status | ||
|
|
||
| The current support for different GHC versions is given in the following table. | ||
|
|
||
| | GHC version | Last supporting HLS version | Deprecation status | | ||
| | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | ||
| | 9.2.0 | not supported yet | | | ||
| | 9.0.1 | [current](https://github.com/haskell/haskell-language-server/releases/latest) ([partial](https://github.com/haskell/haskell-language-server/issues/297)) | | | ||
| | 8.10.7 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | | | ||
| | 8.10.6 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | will be deprecated after LTS for ghc-9.0 | | ||
| | 8.10.5 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | deprecated, will be removed after 1.5.0 | | ||
| | 8.10.4 | [1.4.0](https://github.com/haskell/haskell-language-server/releases/tag/1.4.0) | deprecated | | ||
| | 8.10.3 | [1.4.0](https://github.com/haskell/haskell-language-server/releases/tag/1.4.0) | deprecated | | ||
| | 8.10.2 | [1.4.0](https://github.com/haskell/haskell-language-server/releases/tag/1.4.0) | deprecated | | ||
| | 8.10.1 | [0.9.0](https://github.com/haskell/haskell-language-server/releases/tag/0.9.0) | deprecated | | ||
| | 8.8.4 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | will be deprecated after LTS for ghc-9.2 | | ||
| | 8.8.3 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | deprecated, will be removed after 1.5.0 | | ||
| | 8.8.2 | [1.2.0](https://github.com/haskell/haskell-language-server/releases/tag/1.2.0) | deprecated | | ||
| | 8.6.5 | [current](https://github.com/haskell/haskell-language-server/releases/latest) | will be deprecated after LTS for ghc-9.2 | | ||
| | 8.6.4 | [1.4.0](https://github.com/haskell/haskell-language-server/releases/tag/1.4.0) | deprecated | | ||
|
|
||
| GHC versions not in the list have never been supported by HLS, or are not planned. | ||
|
|
||
| The policy for when we deprecate support for versions of GHC is given below. The table reflects that, but we may decide to deviate from it for good reasons. | ||
|
|
||
| ### Using deprecated GHC versions | ||
|
|
||
| Users who want to use a GHC version which is not supported by the latest HLS can still use older versions of HLS (consult the version support table above to identify the appropriate HLS version). | ||
| In the future, we may extend the existing discovery mechanisms (`haskell-language-server-wrapper`, automatic download in vscode extension) to find and download older HLS binaries in this case. | ||
|
|
||
| Users of a deprecated minor version (where the major version is still supported) can try building the latest HLS from source, which will likely still work, since the GHC API tends to remain compatible across minor versions. | ||
|
|
||
| ## GHC version deprecation policy | ||
|
|
||
| ### Major versions | ||
|
|
||
| A major GHC version is a "legacy" version if it is 3 or more major versions behind the GHC version used in the newest Stackage LTS. HLS will support all non-legacy major versions of GHC. | ||
|
|
||
| ### Minor versions | ||
|
|
||
| For the latest supported major GHC version we will support at least 2 minor versions. | ||
|
|
||
| For the rest of the supported major GHC versions, we will support at least the latest minor version in Stackage LTS (so 1 minor version). | ||
|
|
||
| ### Announcements | ||
|
|
||
| We will warn users about the upcoming deprecation of a GHC version in the notes of the release *prior* to the deprecation itself. | ||
|
|
||
| ### Why deprecate older versions of GHC? | ||
|
|
||
| `haskell-language-server` is highly tied to the GHC API, so much so that it needs to be specially built for each GHC minor version to ensure it will work reliably. | ||
| This means that the codebase is riddled with CPP to handle each supported ghc versions. It even needs entire compatibility packages to fully support older versions of GHC. | ||
| Moreover, our continuous integration setup has to cover all of those cases, which uses a lot of resources. | ||
|
|
||
| So we need to limit the number of versions of GHC that we support in order to save maintainers and contributors time and to reduce the consumption of CI resources. | ||
| This is vital to make HLS development manageable. | ||
|
|
||
| At the same time we aim to support enough GHC versions to minimize the impact on end users. | ||
| This includes making an effort to support users who need to keep using old GHC versions, even if they are out of the support window offered by GHC itself. | ||
|
|
||
| ### What factors do we take into account when deprecating a version? | ||
|
|
||
| To guide the policy (and possible exceptions) we aim to take in account: | ||
| - Completeness of support: all plugins and features should work with that GHC version | ||
| - GHC versions supported by newer [Stackage](https://www.stackage.org/) LTS's | ||
| - GHC versions supported by default in the most popular [Linux distributions](https://repology.org/project/ghc/versions) | ||
| - The specific history of GHC releases and their reliability on the major operating systems (Linux, Windows, MacOS) | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Which one will come first, full 9.0.1 support or stackage LTS for 9.0? If it's the former (and I think this is more likely to happen), I think it's maybe better to mention that one instead of this, or both.
(In "both" case, we may say
with link to the last section on "this section")
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.
Finally i used
will be deprecated after LTS and HLS full support for.., hope it is complete enoughThere 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.
Hmmmm, sounds like we need a term for "a fully supported major version of GHC with a LTS snapshot". That's also important for defining the major version support window. Perhaps the "mainline" GHC version? Then we could say "will be deprecated when 9.0 becomes mainline"?