Merge branch 'master' into cata

Author: isovector

.github/mergify.yml

@@ -1,49 +1,9 @@
 pull_request_rules:
-- actions:
-    merge:
-      strict: smart+fasttrack
-      method: squash
-  name: Automatically merge pull requests
-  conditions:
-  - status-success=bench-example (8.10.4, ubuntu-latest, Cabal-3.0.0.0)
-  - status-success=bench-example (8.10.4, ubuntu-latest, lsp-types-1.0.0.1)
-  # disabled (too slow, ~4h) until hie-bios >0.7.2 is released
-  # - status-success=bench-example (8.10.4, ubuntu-latest, bench_example_HLS)
-
-  - status-success=nix (default, ubuntu-latest)
-  - status-success=nix (default, macOS-latest)
-
-  - status-success=test (8.10.4, ubuntu-latest)
-  - status-success=test (8.10.4, macOS-latest)
-  - status-success=test (8.10.3, ubuntu-latest)
-  - status-success=test (8.10.3, macOS-latest)
-  - status-success=test (8.10.2, ubuntu-latest)
-  - status-success=test (8.10.2, macOS-latest)
-  - status-success=test (8.8.4, ubuntu-latest)
-  - status-success=test (8.8.4, macOS-latest)
-  - status-success=test (8.8.3, ubuntu-latest)
-  - status-success=test (8.8.3, macOS-latest)
-  - status-success=test (8.8.2, ubuntu-latest)
-  - status-success=test (8.8.2, macOS-latest)
-  - status-success=test (8.6.5, ubuntu-latest)
-  - status-success=test (8.6.5, macOS-latest)
-  - status-success=test (8.6.4, ubuntu-latest)
-  - status-success=test (8.6.4, macOS-latest)
-  - status-success=test (windows-latest, 8.10.4, true)
-  - status-success=test (windows-latest, 8.10.3)
-  - status-success=test (windows-latest, 8.6.5, true)
-  - status-success=test (windows-latest, 8.10.2.2)
-  # - status-success=test (windows-latest, 8.6.4)
-
-  - 'status-success=ci/circleci: ghc-8.10.4'
-  - 'status-success=ci/circleci: ghc-8.10.3'
-  - 'status-success=ci/circleci: ghc-8.10.2'
-  - 'status-success=ci/circleci: ghc-8.8.4'
-  - 'status-success=ci/circleci: ghc-8.8.3'
-  - 'status-success=ci/circleci: ghc-8.8.2'
-  - 'status-success=ci/circleci: ghc-8.6.5'
-  - 'status-success=ci/circleci: ghc-8.6.4'
-  - 'status-success=ci/circleci: ghc-default'
-
-  - label=merge me
-  - '#approved-reviews-by>=1'
+  - actions:
+      merge:
+        strict: smart+fasttrack
+        method: squash
+    name: Automatically merge pull requests
+    conditions:
+      - label=merge me
+      - '#approved-reviews-by>=1'

.github/workflows/bench.yml

@@ -58,7 +58,7 @@ jobs:
     # max-backjumps is increased as a temporary solution
     # for dependency resolution failure
     - if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
-      run: cabal configure --enable-benchmarks --max-backjumps 10000
+      run: cabal configure --enable-benchmarks --max-backjumps 12000
 
     - if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
       name: Build

.github/workflows/nix.yml

@@ -4,6 +4,9 @@ on:
   pull_request:
     branches:
       - '**'
+  push:
+    branches:
+      - master
 
 jobs:
   pre_job:
@@ -17,14 +20,14 @@ jobs:
           cancel_others: true
           paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**"]'
 
-  nix:
+  # Enter the development shell and run `cabal build`
+  develop:
     needs: pre_job
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        ghc: ['default']
         os: [ubuntu-latest, macOS-latest]
 
     steps:
@@ -33,13 +36,52 @@ jobs:
       with:
         submodules: true
     - if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
-      uses: cachix/install-nix-action@v12
+      uses: cachix/install-nix-action@v13
       with:
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/lb41az54kzk6j12p81br4bczary7m145/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        extra_nix_config: |
+          experimental-features = nix-command flakes
         nix_path: nixpkgs=channel:nixos-unstable
     - if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
-      uses: cachix/cachix-action@v8
+      uses: cachix/cachix-action@v10
       with:
         name: haskell-language-server
-        authToken: ${{ secrets.HLS_CACHIX_AUTH_TOKEN }}
+        # Disable pushing, we will do that in job `build`
+        skipPush: true
     - if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
-      run: nix-shell --argstr compiler ${{ matrix.ghc }} --run "cabal update && cabal build"
+      run: |
+        nix develop --command cabal update
+        nix develop --command cabal build
+
+  # Build and then push HLS binaries with developmet shell to cachix
+  # This job runs when PRs are merged to master, and should be excluded from branch protections
+  build:
+    runs-on: ${{ matrix.os }}
+    if: ${{ github.repository_owner == 'haskell' && github.ref == 'refs/heads/master' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - uses: cachix/install-nix-action@v13
+      with:
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/lb41az54kzk6j12p81br4bczary7m145/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        extra_nix_config: |
+          experimental-features = nix-command flakes
+        nix_path: nixpkgs=channel:nixos-unstable
+    - uses: cachix/cachix-action@v10
+      with:
+        name: haskell-language-server
+        authToken: ${{ secrets.HLS_CACHIX_AUTH_TOKEN }}
+    - name: Push development shell
+      run: nix develop --profile dev && cachix push haskell-language-server dev
+    - name: Build and push binaries
+      run: |
+        nix build
+        nix path-info --json | jq -r '.[].path' | cachix push haskell-language-server

.gitignore

@@ -41,3 +41,7 @@ test/testdata/**/hie.yaml
 # ghcide-bench
 *.identifierPosition
 /bench/example
+
+# nix
+result
+result-doc

README.md

@@ -78,6 +78,7 @@ background](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-th
       - [Using Cabal](#using-cabal)
       - [Using Stack](#using-stack)
       - [Using Nix](#using-nix)
+        - [Flakes support](#flakes-support)
       - [Introduction tutorial](#introduction-tutorial)
       - [Test your hacked HLS in your editor](#test-your-hacked-hls-in-your-editor)
     - [Adding support for a new editor](#adding-support-for-a-new-editor)
@@ -807,8 +808,27 @@ $ cabal update
 $ cabal build
 ```
 
+##### Flakes support
+
+If you are using nix 2.4 style command (enabled by `experimental-features = nix-command`),
+you can use `nix develop` instead of `nix-shell` to enter the development shell. To enter the shell with specific GHC versions:
+
+* `nix develop` or `nix develop .#haskell-language-server-dev` - default GHC version
+* `nix develop .#haskell-language-server-8104-dev` - GHC 8.10.4
+* `nix develop .#haskell-language-server-884-dev` - GHC 8.8.4
+* `nix develop .#haskell-language-server-901-dev` - GHC 9.0.1
+
 If you are looking for a Nix expression to create haskell-language-server binaries, see https://github.com/haskell/haskell-language-server/issues/122
 
+To create binaries:
+
+* `nix build` or `nix build .#haskell-language-server` - default GHC version
+* `nix build .#haskell-language-server-8104` - GHC 8.10.4
+* `nix build .#haskell-language-server-884` - GHC 8.8.4
+* `nix build .#haskell-language-server-901` - GHC 9.0.1
+
+GHC 8.6.5 is not supported here because `nixpkgs-unstable` no longer maintains the corresponding packages set.
+
 #### Introduction tutorial
 
 Pepeiborra [wrote an tutorial](https://github.com/pepeiborra/hls-tutorial) on writing a plugin in HLS.

cabal.project

@@ -30,7 +30,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-03-29T21:23:14Z
+index-state: 2021-05-21T05:01:41Z
 
 allow-newer:
 	active:base,

default.nix

@@ -0,0 +1,11 @@
+# This file is the compt layer of flakes: https://github.com/edolstra/flake-compat
+# See flake.nix for details
+(import (
+  let
+    lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+  in fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+    sha256 = lock.nodes.flake-compat.locked.narHash; }
+) {
+  src =  ./.;
+}).defaultNix