Distributable binaries

.github/workflows/build.yml

@@ -0,0 +1,116 @@
+name: Builds
+
+on:
+  release:
+    types: [created]
+jobs:
+
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ghc: ['8.10.1', '8.8.3', '8.8.2', '8.6.5', '8.6.4']
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        exclude:
+          - os: windows-latest
+            ghc: '8.8.3' # fails due to segfault
+          - os: windows-latest
+            ghc: '8.8.2' # fails due to error with Cabal
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - uses: actions/[email protected]
+      with:
+        ghc-version: ${{ matrix.ghc }}
+        cabal-version: '3.2'
+
+    - name: Cache Cabal
+      uses: actions/[email protected]
+      with:
+        path: ~/.cabal
+        key: ${{ runner.OS }}-${{ matrix.ghc }}-${{ hashFiles('**/*.cabal') }}
+
+    - name: Shorten binary names
+      shell: bash
+      run: |
+        sed -i.bak -e 's/haskell-language-server/hls/g' \
+                   -e 's/haskell_language_server/hls/g' \
+                   haskell-language-server.cabal
+        sed -i.bak -e 's/Paths_haskell_language_server/Paths_hls/g' \
+                   src/**/*.hs exe/*.hs
+
+    - name: Set some window specific things
+      if: matrix.os == 'windows-latest'
+      shell: bash
+      run: |
+        echo '::set-env name=EXE_EXT::.exe'
+
+    - name: Set some linux specific things
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        echo '::set-env name=LINUX_CABAL_ARGS::--enable-executable-static --ghc-options=-split-sections'
+
+    - name: Build Server
+      shell: bash
+      # Try building it twice in case of flakey builds on Windows
+      run: |
+        cabal build exe:hls -O2 --disable-documentation $LINUX_CABAL_ARGS || \
+        cabal build exe:hls -O2 --disable-documentation $LINUX_CABAL_ARGS
+
+    - name: Find Server Binary
+      id: find_server_binary
+      shell: bash
+      run: |
+        HLS=$(find dist-newstyle \( -name 'hls' -o -name 'hls.exe' \) -type f)
+        gzip --best $HLS
+        echo ::set-output name=hls_binary::$HLS.gz
+
+    - name: Upload Server Binary
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ github.event.release.upload_url }}
+        asset_path: ${{ steps.find_server_binary.outputs.hls_binary }}
+        asset_name: haskell-language-server-${{ runner.OS }}-${{ matrix.ghc }}${{env.EXE_EXT}}.gz
+        asset_content_type: application/gzip
+
+    - uses: actions/upload-artifact@v2
+      with:
+        name: haskell-language-server-${{ runner.OS }}-${{ matrix.ghc }}${{env.EXE_EXT}}.gz
+        path: ${{ steps.find_server_binary.outputs.hls_binary }}
+
+    - name: Build Wrapper
+      if: matrix.ghc == '8.10.1'
+      run: cabal build exe:hls-wrapper -O2 --disable-documentation $WIN_CABAL_ARGS $LINUX_CABAL_ARGS
+
+    - name: Find Wrapper Binary
+      if: matrix.ghc == '8.10.1'
+      id: find_wrapper_binary
+      shell: bash
+      run: |
+        HLS_WRAPPER=$(find dist-newstyle \( -name 'hls-wrapper' -o -name 'hls-wrapper.exe' \) -type f)
+        gzip --best $HLS_WRAPPER
+        echo ::set-output name=hls_wrapper_binary::$HLS_WRAPPER.gz
+
+    - name: Upload Wrapper
+      if: matrix.ghc == '8.10.1'
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ github.event.release.upload_url }}
+        asset_path: ${{ steps.find_wrapper_binary.outputs.hls_wrapper_binary }}
+        asset_name: haskell-language-server-wrapper-${{ runner.OS }}${{env.EXE_EXT}}.gz
+        asset_content_type: application/gzip
+
+    - uses: actions/upload-artifact@v2
+      if: matrix.ghc == '8.10.1'
+      with:
+        name: haskell-language-server-wrapper-${{ runner.OS }}${{env.EXE_EXT}}.gz
+        path: ${{ steps.find_wrapper_binary.outputs.hls_wrapper_binary }}
+

.gitignore

@@ -20,7 +20,7 @@ stack*.yaml.lock
 shake.yaml.lock
 
 # ignore hie.yaml's for testdata
-test/**/*.yaml
+test/testdata/**/hie.yaml
 
 # metadata files on macOS
 .DS_Store

.gitmodules

@@ -13,4 +13,5 @@
 	# url = https://github.com/digital-asset/ghcide.git
 	# url = https://github.com/alanz/ghcide.git
 	# url = https://github.com/wz1000/ghcide.git
-	url = https://github.com/fendor/ghcide.git
+	# url = https://github.com/fendor/ghcide.git
+	url = https://github.com/bubba/ghcide.git

cabal.project

@@ -12,4 +12,4 @@ package ghcide
 
 write-ghc-environment-files: never
 
-index-state: 2020-07-13T21:29:04Z
+index-state: 2020-07-13T21:03:06Z

docs/releases.md

@@ -0,0 +1,72 @@
+# Releases and distributable binaries
+
+Starting with 0.X.0.0 haskell-language-server provides pre-built binaries on
+each [GitHub
+release](https://github.com/haskell/haskell-language-server/releases). These
+binaries are used by the [vscode-hie-server
+extension](https://github.com/alanz/vscode-hie-server) to provide automatic
+installation for users on VS Code, but they can also be installed manually
+when added to the path.
+
+## Making a new release of haskell-language-server
+
+Go to the [GitHub releases
+page](https://github.com/haskell/haskell-language-server/releases) for
+haskell-language-server and start to create a new release. Choose or create a
+tag, fill out the release notes etc., but before you create it
+**make sure to check the pre-release checkbox**. This will prevent VS Code
+*extension
+users from attempting to install this version before the binaries are
+created.
+
+Once the release is created the [GitHub Actions
+workflow](https://github.com/haskell/haskell-language-server/actions) will be
+kicked off and will start creating binaries. They will be gzipped and
+uploaded to the release.
+
+It creates a `haskell-language-server-OS-GHC` binary for each platform
+(Linux, macOS, Windows) and each GHC version that we currently support, as well
+as a `haskell-language-server-wrapper-OS` binary for each platform. Note that
+only one wrapper binary is created per platform, and it should be built with the
+most recent GHC version.
+
+Once all these binaries are present
+
+## Distributable binaries
+In order to compile a hls binary on one machine and have it run on another, you
+need to make sure there are **no hardcoded paths or data-files**.
+
+### ghc libdir
+One noteable thing which cannot be hardcoded is the **GHC libdir** – this is
+a path to `/usr/local/lib/ghc` or something like that, which was previously
+baked in at compile-time with ghc-paths. Note that with static binaries we
+can no longer use this because the GHC libdir of the GitHub Actions machine
+will most almost certainly not exist on the end user's machine.
+Therefore, hie-bios provides `getGhcRuntimeLibDir` to obtain this path on the fly
+by consulting the cradle.
+
+### Static binaries
+We use the word "distributable" here because technically only the Linux builds
+are static. They are built by passing `--enable-executable-static` to cabal.
+Static binaries don't really exist on macOS, and there are issues with
+proprietary code being linked in on Windows. However, the `.dylib`s linked on
+macOS are all already provided by the system:
+
+```
+$ objdump -macho --dylibs-used  haskell-language-server
+haskell-language-server:
+	/usr/lib/libncurses.5.4.dylib (compatibility version 5.4.0, current version 5.4.0)
+	/usr/lib/libiconv.2.dylib (compatibility version 7.0.0, current version 7.0.0)
+	/usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1281.100.1)
+	/usr/lib/libcharset.1.dylib (compatibility version 2.0.0, current version 2.0.0)
+```
+
+## The GitHub Actions workflow
+It just kicks off a matrix of jobs varying across GHC versions and OSs, building
+the binaries with Cabal and extracting them from the dist-newstyle directory.
+The binaries are built with -O2.
+
+One caveat is that we need to rename the binaries from
+haskell-language-server/haskell-language-server-wrapper to hls/hls-wrapper due to
+path length limitations on windows. But whenever we upload them to the release,
+we make sure to upload them as their full name variant.

exe/Arguments.hs

@@ -10,14 +10,11 @@
 module Arguments
   ( Arguments(..)
   , getArguments
-  , ghcideVersion
-  , getLibdir
+  , haskellLanguageServerVersion
   ) where
 
-import Data.Maybe
 import Data.Version
 import Development.GitRev
-import qualified GHC.Paths
 import Options.Applicative
 import Paths_haskell_language_server
 import System.Environment
@@ -37,6 +34,7 @@ data Arguments = Arguments
     , argsDebugOn       :: Bool
     , argsLogFile       :: Maybe String
     , argsThreads       :: Int
+    , argsProjectGhcVersion :: Bool
     } deriving Show
 
 getArguments :: String -> IO Arguments
@@ -80,21 +78,19 @@ arguments exeName = Arguments
           <> value 0
           <> showDefault
            )
+      <*> switch (long "project-ghc-version"
+                  <> help "Work out the project GHC version and print it")
 
 -- ---------------------------------------------------------------------
--- Set the GHC libdir to the nix libdir if it's present.
-getLibdir :: IO FilePath
-getLibdir = fromMaybe GHC.Paths.libdir <$> lookupEnv "NIX_GHC_LIBDIR"
 
-ghcideVersion :: IO String
-ghcideVersion = do
+haskellLanguageServerVersion :: IO String
+haskellLanguageServerVersion = do
   path <- getExecutablePath
   let gitHashSection = case $(gitHash) of
         x | x == "UNKNOWN" -> ""
         x -> " (GIT hash: " <> x <> ")"
-  return $ "ghcide version: " <> showVersion version
+  return $ "haskell-language-server version: " <> showVersion version
              <> " (GHC: " <> VERSION_ghc
              <> ") (PATH: " <> path <> ")"
              <> gitHashSection
 
--- ---------------------------------------------------------------------