Improve add-release-channel, fixes #708

.github/workflows/docker.yaml

@@ -41,7 +41,8 @@ jobs:
       - uses: docker://arm64v8/ubuntu:focal
         name: Cleanup
         with:
-          args: rm -rf .ghcup/
+          args: rm -rf .ghcup/ cabal/ dist-newstyle/ out/
+
       - name: Checkout
         uses: actions/checkout@v3
       - name: Set up Docker Buildx

.github/workflows/release.yaml

@@ -13,8 +13,8 @@ on:
     - cron: '0 2 * * *'
 
 jobs:
-  build-alpine:
+  build-linux:
-    name: Build static linux binary
+    name: Build linux binary
     runs-on: ${{ matrix.os }}
     env:
       CABAL_VER: 3.6.2.0
@@ -203,9 +203,9 @@ jobs:
             ./out/*
 
 
-  test-alpine:
+  test-linux:
     name: Test linux
-    needs: "build-alpine"
+    needs: "build-linux"
     runs-on: ${{ matrix.os }}
     env:
       CABAL_VER: 3.6.2.0
@@ -379,7 +379,7 @@ jobs:
           HOMEBREW_CHANGE_ARCH_TO_ARM: 1
   hls:
     name: hls
-    needs: build-alpine
+    needs: build-linux
     runs-on: ubuntu-latest
     env:
       GHC_VERSION: "8.10.7"
@@ -410,7 +410,7 @@ jobs:
 
   release:
     name: release
-    needs: ["test-alpine", "test-arm", "test-macwin", "hls"]
+    needs: ["test-linux", "test-arm", "test-macwin", "hls"]
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/v')
     steps:

app/ghcup/GHCup/OptParse/Config.hs

@@ -188,9 +188,15 @@ config configCommand settings keybindings runLogger = case configCommand of
       AddSource xs -> do
         doConfig (defaultUserSettings { uUrlSource = Just $ AddSource (xs <> [Right uri]) })
         pure ExitSuccess
-      _ -> do
+      GHCupURL -> do
         doConfig (defaultUserSettings { uUrlSource = Just $ AddSource [Right uri] })
         pure ExitSuccess
+      OwnSource xs -> do
+        doConfig (defaultUserSettings { uUrlSource = Just $ OwnSource (xs <> [Right uri]) })
+        pure ExitSuccess
+      OwnSpec spec -> do
+        doConfig (defaultUserSettings { uUrlSource = Just $ OwnSource ([Left spec, Right uri]) })
+        pure ExitSuccess
 
  where
   doConfig :: MonadIO m => UserSettings -> m ()

docker/arm32v7/Dockerfile

@@ -23,7 +23,7 @@ RUN apt-get update && \
         openssh-client \
         xz-utils \
         zlib1g-dev \
-		libnuma-dev libgmp10 libssl-dev liblzma-dev libbz2-dev wget lsb-release software-properties-common apt-transport-https gcc autoconf automake build-essential gzip \
+		libnuma-dev libgmp10 libssl-dev liblzma-dev libbz2-dev wget lsb-release software-properties-common apt-transport-https gcc autoconf automake build-essential gzip patchelf tree \
 		llvm-9 clang-9 && \
     rm -rf /var/lib/apt/lists/*
 

docker/arm64v8/Dockerfile

@@ -23,7 +23,7 @@ RUN apt-get update && \
         openssh-client \
         xz-utils \
         zlib1g-dev \
-		libnuma-dev libgmp10 libssl-dev liblzma-dev libbz2-dev wget lsb-release software-properties-common apt-transport-https gcc autoconf automake build-essential gzip \
+		libnuma-dev libgmp10 libssl-dev liblzma-dev libbz2-dev wget lsb-release software-properties-common apt-transport-https gcc autoconf automake build-essential gzip patchelf tree \
 		llvm-9 clang-9 && \
     rm -rf /var/lib/apt/lists/*
 

docs/guide.md

@@ -97,6 +97,10 @@ This is the complete list of env variables that change GHCup behavior:
 * `GHCUP_SKIP_UPDATE_CHECK`: Skip the (possibly annoying) update check when you run a command
 * `CC`/`LD` etc.: full environment is passed to the build system when compiling GHC via GHCup
 
+On windows, there's additionally:
+
+* `GHCUP_MSYS2`: Has to point to the root of an existing MSYS2 installation (when installed by GHCup, that's e.g. `C:\ghcup\msys64`). GHCup bootstrap takes care of this usually.
+
 ### XDG support
 
 To enable XDG style directories, set the environment variable `GHCUP_USE_XDG_DIRS` to anything.
@@ -198,6 +202,50 @@ url-source:
   - "https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.7.yaml"
 ```
 
+## Stack integration
+
+Stack manages GHC versions internally by default. In order to make it use ghcup installed
+GHC versions there are two strategies.
+
+### Strategy 1: System GHC (works on all stack versions)
+
+You can instruct stack to use "system" GHC versions (whatever is in PATH). To do so,
+run the following commands:
+
+```sh
+stack config set install-ghc false --global
+stack config set system-ghc  true  --global
+```
+
+### Strategy 2: Stack hooks (new, recommended)
+
+Since stack 2.9.1 you can customize the installation logic of GHC completely, see [https://docs.haskellstack.org/en/stable/yaml_configuration/#ghc-installation-customisation](https://docs.haskellstack.org/en/stable/yaml_configuration/#ghc-installation-customisation).
+
+We can use this to simply invoke ghcup whenever stack is trying to install/discover a GHC versions. This
+is done via placing a shell script at `~/.stack/hooks/ghc-install.sh` and making it executable.
+
+The ghcup bootstrap script asks you during installation whether you want to install this shell script. You can also
+install/update it manually like so:
+
+```sh
+mkdir -p ~/.stack/hooks/
+curl https://raw.githubusercontent.com/haskell/ghcup-hs/master/scripts/hooks/stack/ghc-install.sh \
+  > ~/.stack/hooks/ghc-install.sh
+chmod +x ~/.stack/hooks/ghc-install.sh
+# hooks are only run when 'system-ghc: false'
+stack config set system-ghc false --global
+```
+
+By default, when the hook fails for whatever reason, stack will fall back to its own installation logic. To disable
+this, run `stack config set install-ghc false --global`.
+
+### Windows
+
+On windows, you may find the following config options useful too:
+`skip-msys`, `extra-path`, `extra-include-dirs`, `extra-lib-dirs`.
+
+Also check out: [https://docs.haskellstack.org/en/stable/yaml_configuration](https://docs.haskellstack.org/en/stable/yaml_configuration)
+
 # More on installation
 
 ## Customisation of the installation scripts

lib/GHCup/Utils.hs

@@ -1270,11 +1270,13 @@ warnAboutHlsCompatibility = do
   case (currentGHC, currentHLS) of
     (Just gv, Just hv) | gv `notElem` supportedGHC -> do
       logWarn $
-        "GHC " <> T.pack (prettyShow gv) <> " is not compatible with " <>
+        "GHC-" <> T.pack (prettyShow gv) <> " appears to have no corresponding HLS-" <> T.pack (prettyShow hv) <> " binary." <> "\n" <>
-        "Haskell Language Server " <> T.pack (prettyShow hv) <> "." <> "\n" <>
+        "Haskell IDE support may not work." <> "\n" <>
-        "Haskell IDE support may not work until this is fixed." <> "\n" <>
+        "You can try to either: " <> "\n" <>
-        "Install a different HLS version, or install and set one of the following GHCs:" <> "\n" <>
+        "  1. Install a different HLS version (e.g. downgrade for older GHCs)" <> "\n" <>
-        T.pack (prettyShow supportedGHC)
+        "  2. Install and set one of the following GHCs: " <> T.pack (prettyShow supportedGHC) <> "\n" <>
+        "  3. Let GHCup compile HLS for you, e.g. run: ghcup compile hls -g " <> T.pack (prettyShow hv) <> " --ghc " <> T.pack (prettyShow gv) <> " --cabal-update\n" <>
+        "     (see https://www.haskell.org/ghcup/guide/#hls for more information)"
 
     _ -> return ()