Improve Github CI documentation

Fixes #887

docs/guide.md

@@ -43,6 +43,12 @@ All of the following are valid arguments to `ghcup install ghc`:
 
 If the argument is omitted, the default is `recommended`.
 
+Other tags include:
+
+- `prerelease`: a prerelease version
+- `latest-prerelease`: the latest prerelease version
+
+
 ## Manpages
 
 For man pages to work you need [man-db](http://man-db.nongnu.org/) as your `man` provider, then issue `man ghc`. Manpages only work for the currently set ghc.
@@ -203,34 +209,6 @@ url-source:
   - "https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.7.yaml"
 ```
 
-### Nightlies
-
-Nightlies are just another release channel. Currently, only GHC supports nightlies, which are binary releases
-that are built every night from `master`.
-
-To add the nightly channel, run:
-
-```sh
-ghcup config add-release-channel https://ghc.gitlab.haskell.org/ghcup-metadata/ghcup-nightlies-0.0.7.yaml
-```
-
-To list all nightlies from 2023, run:
-
-```sh
-ghcup list --show-nightly --tool=ghc --since=2023-01-01
-```
-
-Ways to install a nightly:
-
-```sh
-# by date
-ghcup install ghc 2023-06-20
-# by version
-ghcup install ghc 9.7.20230619
-# by tag
-ghcup install ghc latest-nightly
-```
-
 ## Stack integration
 
 Stack manages GHC versions internally by default. In order to make it use ghcup installed
@@ -478,8 +456,48 @@ variables and, in the case of Windows, parameters to tweak the script behavior.
 
 ### github workflows
 
-On github workflows you can use [https://github.com/haskell/actions/](https://github.com/haskell/actions/).
-GHCup itself is also pre-installed on all platforms, but may use non-standard install locations.
+On github workflows GHCup itself is pre-installed on all platforms, but may use non-standard install locations.
+Here's an example workflow with a GHC matrix:
+
+```yaml
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-22.04, macOS-latest]
+        ghc: ['9.6', '9.4', '9.2', '9.0', '8.10', '8.8', '8.6']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup toolchain
+      run: |
+        ghcup install cabal --set recommended
+        ghcup install ghc --set ${{ matrix.ghc }}
+    - name: Build
+      run: |
+        cabal update
+        cabal test all --test-show-details=direct
+
+  i386:
+    runs-on: ubuntu-latest
+    container:
+      image: i386/ubuntu:bionic
+    steps:
+    - name: Install GHCup in container
+      run: |
+        apt-get update -y
+        apt-get install -y autoconf build-essential zlib1g-dev libgmp-dev curl
+        # we just go with recommended versions of cabal and GHC
+        curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | BOOTSTRAP_HASKELL_NONINTERACTIVE=1 BOOTSTRAP_HASKELL_INSTALL_NO_STACK=1 sh
+    - uses: actions/checkout@v1
+    - name: Test
+      run: |
+        # in containers we need to fix PATH
+        source ~/.ghcup/env
+        cabal update
+        cabal test all --test-show-details=direct
+```
 
 ## GPG verification
 
@@ -489,9 +507,10 @@ this is cryptographically secure.
 First, obtain the gpg keys:
 
 ```sh
-gpg --batch --keyserver keys.openpgp.org     --recv-keys 7D1E8AFD1D4A16D71FADA2F2CCC85C0E40C06A8C
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys 7D1E8AFD1D4A16D71FADA2F2CCC85C0E40C06A8C
 gpg --batch --keyserver keyserver.ubuntu.com --recv-keys FE5AB6C91FEA597C3B31180B73EDE9E8CFBAEF01
 gpg --batch --keyserver keyserver.ubuntu.com --recv-keys 88B57FCF7DB53B4DB3BFA4B1588764FBE22D19C4
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys EAF2A9A722C0C96F2B431CA511AAD8CEDEE0CAEF
 ```
 
 Then verify the gpg key in one of these ways:

docs/install.md

@@ -296,7 +296,14 @@ Lower availability of bindists. Stack and HLS binaries are experimental.
 Download the binary for your platform at [https://downloads.haskell.org/~ghcup/](https://downloads.haskell.org/~ghcup/)
 and place it into your `PATH` anywhere.
 
-If you want to GPG verify the binaries, import the following keys first: `7D1E8AFD1D4A16D71FADA2F2CCC85C0E40C06A8C` and `FE5AB6C91FEA597C3B31180B73EDE9E8CFBAEF01`.
+If you want to GPG verify the binaries, import the following keys first:
+
+```sh
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys 7D1E8AFD1D4A16D71FADA2F2CCC85C0E40C06A8C
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys FE5AB6C91FEA597C3B31180B73EDE9E8CFBAEF01
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys 88B57FCF7DB53B4DB3BFA4B1588764FBE22D19C4
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys EAF2A9A722C0C96F2B431CA511AAD8CEDEE0CAEF
+```
 
 Then adjust your `PATH` in `~/.bashrc` (or similar, depending on your shell) like so:
 

ghcup.cabal

@@ -25,10 +25,10 @@ extra-source-files:
   cbits/dirutils.h
   data/build_mk/cross
   data/build_mk/default
-  test/data/dir/.keep
-  test/data/file
-  test/golden/unix/GHCupInfo.json
-  test/golden/windows/GHCupInfo.json
+  test/ghcup-test/data/dir/.keep
+  test/ghcup-test/data/file
+  test/ghcup-test/golden/unix/GHCupInfo.json
+  test/ghcup-test/golden/windows/GHCupInfo.json
 
 source-repository head
   type:     git
@@ -236,7 +236,7 @@ library
 
   if (flag(tui) && !os(windows))
     cpp-options:   -DBRICK
-    build-depends: vty ^>=5.37
+    build-depends: vty ^>=5.39
 
 library ghcup-optparse
   import:             app-common-depends
@@ -261,7 +261,7 @@ library ghcup-optparse
     GHCup.OptParse.Upgrade
     GHCup.OptParse.Whereis
 
-  hs-source-dirs:     app/ghcup
+  hs-source-dirs:     lib-opt
   default-language:   Haskell2010
   default-extensions:
     LambdaCase
@@ -284,12 +284,6 @@ library ghcup-optparse
 
   if (flag(tui) && !os(windows))
     cpp-options:   -DBRICK
-    other-modules: BrickMain
-    build-depends:
-      , brick         ^>=1.5
-      , transformers  ^>=0.5
-      , unix          ^>=2.7
-      , vty           ^>=5.37
 
   if os(windows)
     cpp-options: -DIS_WINDOWS
@@ -300,26 +294,6 @@ library ghcup-optparse
 executable ghcup
   import:             app-common-depends
   main-is:            Main.hs
-  other-modules:
-    GHCup.OptParse
-    GHCup.OptParse.ChangeLog
-    GHCup.OptParse.Common
-    GHCup.OptParse.Compile
-    GHCup.OptParse.Config
-    GHCup.OptParse.DInfo
-    GHCup.OptParse.GC
-    GHCup.OptParse.Install
-    GHCup.OptParse.List
-    GHCup.OptParse.Nuke
-    GHCup.OptParse.Prefetch
-    GHCup.OptParse.Rm
-    GHCup.OptParse.Run
-    GHCup.OptParse.Set
-    GHCup.OptParse.Test
-    GHCup.OptParse.ToolRequirements
-    GHCup.OptParse.UnSet
-    GHCup.OptParse.Upgrade
-    GHCup.OptParse.Whereis
 
   hs-source-dirs:     app/ghcup
   default-language:   Haskell2010
@@ -351,7 +325,7 @@ executable ghcup
       , brick         ^>=1.5
       , transformers  ^>=0.5
       , unix          ^>=2.7
-      , vty           ^>=5.37
+      , vty           ^>=5.39
 
   if os(windows)
     cpp-options: -DIS_WINDOWS

lib-opt/GHCup/OptParse/Common.hs

@@ -824,7 +824,7 @@ checkForUpdates = do
 
 logGHCPostRm :: (MonadReader env m, HasLog env, MonadIO m) => GHCTargetVersion -> m ()
 logGHCPostRm ghcVer = do
-  cabalStore <- liftIO $ handleIO (\_ -> if isWindows then pure "C:\\cabal\\store" else pure "~/.cabal/store")
+  cabalStore <- liftIO $ handleIO (\_ -> if isWindows then pure "C:\\cabal\\store" else pure "~/.cabal/store or ~/.local/state/cabal/store")
     (runIdentity . CC.cfgStoreDir <$> CC.readConfig)
   let storeGhcDir = cabalStore </> ("ghc-" <> T.unpack (prettyVer $ _tvVersion ghcVer))
   logInfo $ T.pack $ "After removing GHC you might also want to clean up your cabal store at: " <> storeGhcDir

lib/GHCup/Types.hs

@@ -157,13 +157,17 @@ instance NFData VersionInfo
 
 
 -- | A tag. These are currently attached to a version of a tool.
-data Tag = Latest
-         | Recommended
-         | Prerelease
-         | LatestPrerelease
-         | Nightly
-         | LatestNightly
-         | Base PVP
+data Tag = Latest             -- ^ the latest version of a tool (unique per tool)
+         | Recommended        -- ^ the recommended version of a tool (unique per tool)
+         | Prerelease         -- ^ denotes a prerelease version
+                              --   (a version should either be 'Prerelease' or
+                              --   'LatestPrerelease', but not both)
+         | LatestPrerelease   -- ^ the latest prerelease (unique per tool)
+         | Nightly            -- ^ denotes a nightly version
+                              --   (a version should either be 'Nightly' or
+                              --   'LatestNightly', but not both)
+         | LatestNightly      -- ^ the latest nightly (unique per tool)
+         | Base PVP           -- ^ the base version shipped with GHC
          | Old                -- ^ old versions are hidden by default in TUI
          | UnknownTag String  -- ^ used for upwardscompat
          deriving (Ord, Eq, GHC.Generic, Show) -- FIXME: manual JSON instance

stack.yaml

@@ -1,4 +1,4 @@
-resolver: lts-20.20
+resolver: lts-20.26
 
 packages:
   - .