Add ghc deprecation policy to documentation #2231
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 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | |||||||||||||||||
| # GHC support deprecation policy | |||||||||||||||||
|
|
|||||||||||||||||
| - `haskell-language-server`(HLS) is highly tied to ghc api so much so that it needs a specific flavour for each ghc minor version to ensure it will work in a reliable way | |||||||||||||||||
| - It supposes the codebase is riddled with code conditioned to each supported ghc versions. It even needs entire packages to fully support older versions of ghc. | |||||||||||||||||
| - Our continouos integracion setup has to cover all those cases so it have to use lot of resources to test and build the executable. | |||||||||||||||||
| - So we need to limit the ghc support to save maintainers and contributors time and reduce ci resources consumption. It becomes vital to make HLS development manageable. | |||||||||||||||||
| - At same time we aim to support the right balance of ghc versions to minimize impact to final users who usually needs to keep using older ghc versions, even if they are out of the window support offered by ghc itself. | |||||||||||||||||
| - To establish the policy and the possible exceptions we aim to take in account: | |||||||||||||||||
| - completeness of support: the GHC flavour should include all plugins and features | |||||||||||||||||
| - 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 realibility on the major operating systems (linux, windows, macos) | |||||||||||||||||
| - It worths to note that users of deprecated ghc versions always will have the option of: | |||||||||||||||||
| - Continue using the last HLS with support for their ghc version. So they will miss new bug fixes and features. | |||||||||||||||||
| - For deprecated minor versions of a still supported major version, try to build HLS from source. | |||||||||||||||||
| - We will not guarentee it will work but will do quite likely. | |||||||||||||||||
|
|
|||||||||||||||||
| ## Deprecation policy | |||||||||||||||||
|
|
|||||||||||||||||
| - A GHC version is legacy if it is 3 or more major versions away from the newest stackage LTS ghc version | |||||||||||||||||
| - HLS will build on all non-legacy (major) versions of GHC, | |||||||||||||||||
| - for the latest major GHC version we will support at least 2 minor versions | |||||||||||||||||
| - for the rest of major supported GHC versions we will support at least the latest GHC minor version in stackage LTS (so 1 minor version) | |||||||||||||||||
| - We may extend the existing discovery mechanisms (hls-wrapper, automatic download in vscode extension) to find and download older HLS binaries when it detects a legacy GHC version | |||||||||||||||||
| - We will warn users about the deprecated ghc version in the notes of the release *prior* to the deprecation itself. | |||||||||||||||||
|
|
|||||||||||||||||
| ## Deprecation prevision | |||||||||||||||||
|
There was a problem hiding this comment. I think this is not the table that our users actually care about. Our users probably want to know which GHC versions are supported now, and how will that change in future. Maybe that should be a separate table. I suggest something like this (content is random since I don't know off the top of my head!)
Then we can link to this policy to explain when support gets dropped. There was a problem hiding this comment. hmm i am afraid that it will not depend on the hls version itself, only on stackage lts but i got the idea |
|||||||||||||||||
|
|
|||||||||||||||||
| | newest LTS ghc version | supported ghc versions | | |||||||||||||||||
| |------------------------|-------------------------------------------------| | |||||||||||||||||
| | 8.10.7 | 8.10.7, 8.10.6, 8.10.5(\*), 8.8.4, 8.8.3(\*), 8.6.5 | | |||||||||||||||||
| | 9.0.1 | 9.0.1, 8.10.7, 8.8.4, 8.6.5(\*) | | |||||||||||||||||
| | 9.0.2 | 9.0.2, 9.0.1, 8.10.7, 8.8.4, 8.6.5(\*) | | |||||||||||||||||
| | 9.2.0 | 9.2.0, 9.0.2, 8.10.7, 8.8.4 | | |||||||||||||||||
|
|
|||||||||||||||||
| - versions with `*` are versions which should be removed accordingly to the policy but we will keep due to the specific history of realibilty of recent ghc versions | |||||||||||||||||
| - this prevision is not definitive and may vary depending on changes in the criteria listed above (but always honouring the policy) | |||||||||||||||||
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 | ||
| ======================= | ||
|
|
||
| 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 | ||
| configuration | ||
| ghc-deprecation | ||
| troubleshooting | ||
| contributing/index |
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.
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.
It looks cleaner, thanks, but why does it remove
the specific history of ghc releases and their realibility...?I think this is the real reason behind keep 8.6.5 and 8.10.5 and it is previsible that we should take that in account, even being an ambiguous consideration
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.
Is it? I thought we are not making any exceptions and therefore not keeping 8.6.5, and for 8.10.5 the reason was a Linux distro.
I removed because it's poorly defined and likely to lead to disagreements, and I don't think it's needed.
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.
Well , we disagree here i think users will like to know we aim to be flexible and will listen their opinion about their use cases and ghc versioning. It is more a statement of principles than a definition.
Maintainers will have always the last word.