Merge branch 'master' into random-test-ghc-env

Author: mpilgrem

.github/workflows/arm64-release.yml

@@ -1,4 +1,4 @@
-name: ARM64 Release
+name: ARM64 (AArch64) Release
 
 on:
   pull_request:
@@ -17,18 +17,18 @@ jobs:
     runs-on: [self-hosted, linux, ARM64]
     steps:
     - name: Clone project
-      uses: actions/checkout@v2
-    - shell: bash
+      uses: actions/checkout@v3
+    - name: Build bindist
+      shell: bash
       run: |
         set -ex
-
         docker build . -f etc/dockerfiles/arm64.Dockerfile -t stack --build-arg USERID=$(id -u) --build-arg GROUPID=$(id -g)
         rm -rf _release
         mkdir -p _release
         docker run --rm -v $(pwd):/src -w /src stack bash -c "/home/stack/release build"
 
     - name: Upload bindist
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: Linux-ARM64
         path: _release/stack-*

.github/workflows/integration-tests.yml

@@ -9,10 +9,12 @@ on:
     - rc/**
     tags:
     - '**'
-  schedule:
-  - cron: "0 0 * * *"
   workflow_dispatch:
 
+# As of 11 August 2022, ubuntu-latest, windows-latest and macos-latest come with
+# Stack 2.7.5. windows-latest comes with NSIS 3.08, for which the default value
+# of the 'Unicode' installer attribute is 'true'.
+
 jobs:
   integration-tests:
     name: Integration tests
@@ -26,52 +28,56 @@ jobs:
           cache-bust: ""
         - os: windows-latest
           release-args: ""
-          cache-bust: ""
+          cache-bust: "13"
         - os: macos-latest
           release-args: ""
-          cache-bust: "1"
+          cache-bust: "23"
     steps:
     - name: Clone project
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Cache dependencies on Unix-like OS
       if: startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS')
       uses: actions/cache@v3
       with:
         path: ~/.stack
-        key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}${{ matrix.cache-bust }}
+        key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}-${{ matrix.cache-bust }}
     - name: Cache dependencies on Windows
       if: startsWith(runner.os, 'Windows')
       uses: actions/cache@v3
       with:
         path: |
           ~\AppData\Roaming\stack
           ~\AppData\Local\Programs\stack
-        key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}${{ matrix.cache-bust }}
-    - shell: bash
-      name: Install deps and run checks
+        key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}-${{ matrix.cache-bust }}
+    - name: Install deps and run checks
+      shell: bash
       run: |
         set -ex
 
-        # Work around 'git status' always showing symlinks modified on Windows; see
-        # https://github.com/git-for-windows/git/issues/2653#issuecomment-640234081
-        git config --global core.fscache false
-
-        stack upgrade || curl -sSL https://get.haskellstack.org/ | sh -s - -f
-
         if [[ "${{ matrix.os }}" == "ubuntu-latest" ]]
         then
           # Retry installing nix due to nondeterministic error
           #   Fatal error: glibc detected an invalid stdio handle
           # See:
           #   https://github.com/nh2/static-haskell-nix/pull/27#issuecomment-502652181
           #   https://github.com/NixOS/nix/issues/2733
-          (for i in {1..5}; do bash <(curl -sSL https://nixos.org/nix/install) && exit 0; done; exit 1)
+          (for i in {1..5}; do bash <(curl -sSL https://nixos.org/nix/install) --no-daemon && exit 0; done; exit 1)
           . ~/.nix-profile/etc/profile.d/nix.sh
-          nix-channel --add https://nixos.org/channels/nixos-19.09 nixpkgs
+          nix-channel --add https://nixos.org/channels/nixos-22.05 nixpkgs
           nix-channel --update # Get GHC 8.2.2
-        elif [[ "${{ matrix.os }}" == "windows-latest" ]]
+        fi
+
+        if [[ "${{ matrix.release-args }}" == "--alpine" ]]
         then
-          choco install nsis-unicode -y
+            mkdir -p ~/.stack
+            touch ~/.stack/config.yaml
+            cat > ~/.stack/config.yaml <<EOF
+            extra-include-dirs:
+            - /usr/include
+            extra-lib-dirs:
+            - /lib
+            - /usr/lib
+        EOF
         fi
 
         # Do this in the same step as installing deps to get relevant env var modifications
@@ -84,7 +90,7 @@ jobs:
       run: stack etc/scripts/release.hs build ${{ matrix.release-args }}
 
     - name: Upload bindist
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: ${{ runner.os }}
         path: _release/stack-*
@@ -96,17 +102,17 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/')
     steps:
     - name: Download Linux artifact
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         name: Linux
         path: _release
     - name: Download macOS artifact
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         name: macOS
         path: _release
     - name: Download Windows artifact
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         name: Windows
         path: _release

.github/workflows/lint.yml

@@ -3,6 +3,10 @@ name: Linting
 on:
   pull_request:
   push:
+    branches:
+    - master
+    - stable
+    - rc/**
 
 jobs:
   style:

.github/workflows/stan.yml

@@ -0,0 +1,51 @@
+name: stan
+
+# Disabled because Stan does not yet support GHC >= 9.0. See:
+# https://github.com/kowainik/stan/issues/423
+
+# on:
+#   pull_request:
+#   push:
+#     branches:
+#     - master
+#     - stable
+#     - rc/**
+
+jobs:
+  build:
+    name: ghc ${{ matrix.ghc }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        cabal: ["3.6"]
+        ghc:
+        - "8.10.7"
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+
+    - uses: haskell/actions/setup@v1
+      name: Setup GHC and cabal-install
+      with:
+        ghc-version: ${{ matrix.ghc }}
+        cabal-version: ${{ matrix.cabal }}
+
+    - uses: actions/cache@v2
+      name: cache ~/.cabal/store
+      with:
+        path: ~/.cabal/store
+        key: ${{ runner.os }}-${{ matrix.ghc }}-cabal
+
+    - name: update
+      run: cabal update
+
+    - name: install stan
+      run: cabal install stan --installdir=.bin --install-method=copy --overwrite-policy=always
+
+    - name: generate .hie for analysis
+      run: cabal build stack:lib:stack
+
+    - name: stan
+      run: .bin/stan report

.github/workflows/unit-tests.yml

@@ -9,6 +9,9 @@ on:
     - rc/**
   workflow_dispatch:
 
+# As of 11 August 2022, ubuntu-latest, windows-latest and macos-latest come with
+# Stack 2.7.5. ubuntu-latest comes with GHC 9.2.4.
+
 jobs:
   pedantic:
     name: Pedantic
@@ -17,7 +20,7 @@ jobs:
     - name: Clone project
       uses: actions/checkout@v3
     - name: Cache dependencies
-      uses: actions/cache@v1
+      uses: actions/cache@v3
       with:
         path: ~/.stack
         key: ${{ runner.os }}-${{ hashFiles('stack.yaml') }}
@@ -40,44 +43,50 @@ jobs:
           stack-yaml: stack.yaml
           extra-suffix: "alpine"
           stack-args: "--docker --system-ghc --no-install-ghc --flag stack:static"
-        - os: ubuntu-latest
-          stack-yaml: stack-ghc-902.yaml
-          extra-suffix: ""
-          stack-args: ""
         - os: windows-latest
           stack-yaml: stack.yaml
           extra-suffix: ""
           stack-args: ""
-        - os: windows-latest
-          stack-yaml: stack-ghc-902.yaml
-          extra-suffix: ""
-          stack-args: ""
         - os: macos-latest
-          stack-yaml: stack.yaml
+          stack-yaml: stack-macos.yaml
           extra-suffix: ""
           stack-args: ""
     steps:
     - name: Clone project
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Cache dependencies on Unix-like OS
       if: startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS')
       uses: actions/cache@v3
       with:
         path: ~/.stack
-        key: ${{ runner.os }}-${{ hashFiles( matrix.stack-yaml ) }}-${{ matrix.extra-suffix }}
+        key: ${{ runner.os }}-${{ hashFiles(matrix.stack-yaml) }}-${{ matrix.extra-suffix }}
     - name: Cache dependencies on Windows
       if: startsWith(runner.os, 'Windows')
       uses: actions/cache@v3
       with:
         path: |
           ~\AppData\Roaming\stack
           ~\AppData\Local\Programs\stack
-        key: ${{ runner.os }}-${{ hashFiles( matrix.stack-yaml ) }}-${{ matrix.extra-suffix }}
-    - shell: bash
+        key: ${{ runner.os }}-${{ hashFiles(matrix.stack-yaml) }}-${{ matrix.extra-suffix }}
+    - name: Run tests
+      shell: bash
       run: |
         set -ex
-        stack upgrade || curl -sSL https://get.haskellstack.org/ | sh -s - -f
-        stack test ${{ matrix.stack-args }} --haddock --no-haddock-deps --ghc-options="-Werror" --copy-bins --local-bin-path bin
+
+        if [[ "${{ matrix.extra-suffix }}" == "alpine" ]]
+        then
+            mkdir -p ~/.stack
+            touch ~/.stack/config.yaml
+            cat > ~/.stack/config.yaml <<EOF
+            extra-include-dirs:
+            - /usr/include
+            extra-lib-dirs:
+            - /lib
+            - /usr/lib
+        EOF
+        fi
+
+        stack test ${{ matrix.stack-args }} --stack-yaml ${{ matrix.stack-yaml }} --haddock --no-haddock-deps --ghc-options="-Werror -O0" --copy-bins --local-bin-path bin
 
         # Get output about whether the exe is dynamically linked
         if [[ "${{ matrix.os }}" == "macos-latest" ]]

.gitignore

@@ -1,31 +1,48 @@
+# Cabal and GHC build artefacts
+dist/
+dist-newstyle/
 *.hi
 *.o
+
+# Haskell Tool Stack-related
+.stack-work/
+test/integration/tests/**/*.yaml.lock
+
+# Stack's GitHub workflow-related
+_release/
+
+# MkDocs-related
+_site/
+
+# Stan-related
+.hie
+stan.html
+
+# Emacs-related
+.dir-locals.el
+*_flymake.hs
+
+# Vim-related
 *.swp
 *.tag
-*~
-*_flymake.hs
+
+# IntelliJ IDE-related
+.idea/
+*.iml
+
+# hsenv-related
 .hsenv
-.stack-work/
-.stack-root/
-/.cabal-sandbox/
-TAGS
-/Setup
-cabal-dev/
-cabal.sandbox.config
-dist/
-tags
-/_release/
+
+# Vagrant-related
 .vagrant/
-*.imports
-/.idea/
-/*.iml
-/src/highlight.js
-/src/style.css
-/_site/
-/.dir-locals.el
-/.git/
-/etc/scripts/stack-scripts.cabal
+
+# HSpec-related
 .hspec-failures
+
+# Unexplained
+*~
+*.imports
+src/highlight.js
+src/style.css
+etc/scripts/stack-scripts.cabal
 better-cache/
-stack*.yaml.lock
-dist-newstyle/

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.6"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: doc/requirements.txt