Support for weeder step

cabal.haskell-ci

@@ -36,6 +36,11 @@ benchmarks: True
 -- Build haddocks. Accepts booleans or version range.
 haddock: True
 
+-- Run weeder. Accepts booleans or version range.
+-- Expects 'weeder.toml' to live at the repository root,
+-- and the '.hie/' directory to be generated in the repository root.
+weeder: True
+
 -- Run cabal check
 -- cabal-check: True
 

fixtures/weeder.github

@@ -0,0 +1,343 @@
+# SUCCESS
+# *INFO* Generating GitHub config for testing for GHC versions: 8.0.1 8.0.2 8.2.1 8.2.2 8.4.1 8.4.2 8.4.3 8.4.4 8.6.1 8.6.2 8.6.3 8.6.4 8.6.5 8.8.1 8.8.2 8.8.3 8.8.4 8.10.1 8.10.2 8.10.3 8.10.4 8.10.5 8.10.6 8.10.7
+# This GitHub workflow config has been generated by a script via
+#
+#   haskell-ci 'github' 'weeder.project'
+#
+# To regenerate the script (for example after adjusting tested-with) run
+#
+#   haskell-ci regenerate
+#
+# For more information, see https://github.com/haskell-CI/haskell-ci
+#
+# REGENDATA ["github","weeder.project"]
+#
+name: Haskell-CI
+on:
+  - push
+  - pull_request
+jobs:
+  linux:
+    name: Haskell-CI - Linux - ${{ matrix.compiler }}
+    runs-on: ubuntu-20.04
+    timeout-minutes:
+      60
+    container:
+      image: buildpack-deps:jammy
+    continue-on-error: ${{ matrix.allow-failure }}
+    strategy:
+      matrix:
+        include:
+          - compiler: ghc-8.10.7
+            compilerKind: ghc
+            compilerVersion: 8.10.7
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.6
+            compilerKind: ghc
+            compilerVersion: 8.10.6
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.5
+            compilerKind: ghc
+            compilerVersion: 8.10.5
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.4
+            compilerKind: ghc
+            compilerVersion: 8.10.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.3
+            compilerKind: ghc
+            compilerVersion: 8.10.3
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.2
+            compilerKind: ghc
+            compilerVersion: 8.10.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.10.1
+            compilerKind: ghc
+            compilerVersion: 8.10.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.8.4
+            compilerKind: ghc
+            compilerVersion: 8.8.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.8.3
+            compilerKind: ghc
+            compilerVersion: 8.8.3
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.8.2
+            compilerKind: ghc
+            compilerVersion: 8.8.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.8.1
+            compilerKind: ghc
+            compilerVersion: 8.8.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.6.5
+            compilerKind: ghc
+            compilerVersion: 8.6.5
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.6.4
+            compilerKind: ghc
+            compilerVersion: 8.6.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.6.3
+            compilerKind: ghc
+            compilerVersion: 8.6.3
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.6.2
+            compilerKind: ghc
+            compilerVersion: 8.6.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.6.1
+            compilerKind: ghc
+            compilerVersion: 8.6.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.4.4
+            compilerKind: ghc
+            compilerVersion: 8.4.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.4.3
+            compilerKind: ghc
+            compilerVersion: 8.4.3
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.4.2
+            compilerKind: ghc
+            compilerVersion: 8.4.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.4.1
+            compilerKind: ghc
+            compilerVersion: 8.4.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.2.2
+            compilerKind: ghc
+            compilerVersion: 8.2.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.2.1
+            compilerKind: ghc
+            compilerVersion: 8.2.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.0.2
+            compilerKind: ghc
+            compilerVersion: 8.0.2
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-8.0.1
+            compilerKind: ghc
+            compilerVersion: 8.0.1
+            setup-method: ghcup
+            allow-failure: false
+      fail-fast: false
+    steps:
+      - name: apt
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5 libnuma-dev
+          mkdir -p "$HOME/.ghcup/bin"
+          curl -sL https://downloads.haskell.org/ghcup/0.1.30.0/x86_64-linux-ghcup-0.1.30.0 > "$HOME/.ghcup/bin/ghcup"
+          chmod a+x "$HOME/.ghcup/bin/ghcup"
+          "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)
+          "$HOME/.ghcup/bin/ghcup" install cabal 3.12.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
+        env:
+          HCKIND: ${{ matrix.compilerKind }}
+          HCNAME: ${{ matrix.compiler }}
+          HCVER: ${{ matrix.compilerVersion }}
+      - name: Set PATH and environment variables
+        run: |
+          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
+          echo "LANG=C.UTF-8" >> "$GITHUB_ENV"
+          echo "CABAL_DIR=$HOME/.cabal" >> "$GITHUB_ENV"
+          echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"
+          HCDIR=/opt/$HCKIND/$HCVER
+          HC=$("$HOME/.ghcup/bin/ghcup" whereis ghc "$HCVER")
+          HCPKG=$(echo "$HC" | sed 's#ghc$#ghc-pkg#')
+          HADDOCK=$(echo "$HC" | sed 's#ghc$#haddock#')
+          echo "HC=$HC" >> "$GITHUB_ENV"
+          echo "HCPKG=$HCPKG" >> "$GITHUB_ENV"
+          echo "HADDOCK=$HADDOCK" >> "$GITHUB_ENV"
+          echo "CABAL=$HOME/.ghcup/bin/cabal-3.12.1.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+          HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')
+          echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"
+          echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"
+          echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"
+          echo "HEADHACKAGE=false" >> "$GITHUB_ENV"
+          echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"
+          echo "GHCJSARITH=0" >> "$GITHUB_ENV"
+        env:
+          HCKIND: ${{ matrix.compilerKind }}
+          HCNAME: ${{ matrix.compiler }}
+          HCVER: ${{ matrix.compilerVersion }}
+      - name: env
+        run: |
+          env
+      - name: write cabal config
+        run: |
+          mkdir -p $CABAL_DIR
+          cat >> $CABAL_CONFIG <<EOF
+          remote-build-reporting: anonymous
+          write-ghc-environment-files: never
+          remote-repo-cache: $CABAL_DIR/packages
+          logs-dir:          $CABAL_DIR/logs
+          world-file:        $CABAL_DIR/world
+          extra-prog-path:   $CABAL_DIR/bin
+          symlink-bindir:    $CABAL_DIR/bin
+          installdir:        $CABAL_DIR/bin
+          build-summary:     $CABAL_DIR/logs/build.log
+          store-dir:         $CABAL_DIR/store
+          install-dirs user
+            prefix: $CABAL_DIR
+          repository hackage.haskell.org
+            url: http://hackage.haskell.org/
+          EOF
+          cat >> $CABAL_CONFIG <<EOF
+          program-default-options
+            ghc-options: $GHCJOBS +RTS -M3G -RTS
+          EOF
+          cat $CABAL_CONFIG
+      - name: versions
+        run: |
+          $HC --version || true
+          $HC --print-project-git-commit-id || true
+          $CABAL --version || true
+      - name: update cabal index
+        run: |
+          $CABAL v2-update -v
+      - name: install cabal-plan
+        run: |
+          mkdir -p $HOME/.cabal/bin
+          curl -sL https://github.com/haskell-hvr/cabal-plan/releases/download/v0.7.3.0/cabal-plan-0.7.3.0-x86_64-linux.xz > cabal-plan.xz
+          echo 'f62ccb2971567a5f638f2005ad3173dba14693a45154c1508645c52289714cb2  cabal-plan.xz' | sha256sum -c -
+          xz -d < cabal-plan.xz > $HOME/.cabal/bin/cabal-plan
+          rm -f cabal-plan.xz
+          chmod a+x $HOME/.cabal/bin/cabal-plan
+          cabal-plan --version
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          path: source
+      - name: initial cabal.project for sdist
+        run: |
+          touch cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/servant" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/servant-client" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/servant-docs" >> cabal.project
+          cat cabal.project
+      - name: sdist
+        run: |
+          mkdir -p sdist
+          $CABAL sdist all --output-dir $GITHUB_WORKSPACE/sdist
+      - name: unpack
+        run: |
+          mkdir -p unpacked
+          find sdist -maxdepth 1 -type f -name '*.tar.gz' -exec tar -C $GITHUB_WORKSPACE/unpacked -xzvf {} \;
+      - name: generate cabal.project
+        run: |
+          PKGDIR_servant="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/servant-[0-9.]*')"
+          echo "PKGDIR_servant=${PKGDIR_servant}" >> "$GITHUB_ENV"
+          PKGDIR_servant_client="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/servant-client-[0-9.]*')"
+          echo "PKGDIR_servant_client=${PKGDIR_servant_client}" >> "$GITHUB_ENV"
+          PKGDIR_servant_docs="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/servant-docs-[0-9.]*')"
+          echo "PKGDIR_servant_docs=${PKGDIR_servant_docs}" >> "$GITHUB_ENV"
+          rm -f cabal.project cabal.project.local
+          touch cabal.project
+          touch cabal.project.local
+          echo "packages: ${PKGDIR_servant}" >> cabal.project
+          echo "packages: ${PKGDIR_servant_client}" >> cabal.project
+          echo "packages: ${PKGDIR_servant_docs}" >> cabal.project
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package servant" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package servant-client" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package servant-docs" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          cat >> cabal.project <<EOF
+          EOF
+          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: any.$_ installed\n" unless /^(servant|servant-client|servant-docs)$/; }' >> cabal.project.local
+          cat cabal.project
+          cat cabal.project.local
+      - name: dump install plan
+        run: |
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dry-run all
+          cabal-plan
+      - name: restore cache
+        uses: actions/cache/restore@v4
+        with:
+          key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
+          path: ~/.cabal/store
+          restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-
+      - name: install dependencies
+        run: |
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
+      - name: build w/o tests
+        run: |
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
+      - name: build
+        run: |
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
+      - name: tests
+        run: |
+          $CABAL v2-test $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
+      - name: cabal check
+        run: |
+          cd ${PKGDIR_servant} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_servant_client} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_servant_docs} || false
+          ${CABAL} -vnormal check
+      - name: haddock
+        run: |
+          $CABAL v2-haddock --disable-documentation --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
+      - name: "weeder: servant"
+        uses: freckle/weeder-action@v2
+        if: ${{ env.HCNUMVER < 81000 }}
+        with:
+          ghc-version: ${{ matrix.compilerVersion }}
+          weeder-arguments: --config $GITHUB_WORKSPACE/source/weeder.toml
+          working-directory: ${{ env.PKGDIR_servant }}
+      - name: "weeder: servant-client"
+        uses: freckle/weeder-action@v2
+        if: ${{ env.HCNUMVER < 81000 }}
+        with:
+          ghc-version: ${{ matrix.compilerVersion }}
+          weeder-arguments: --config $GITHUB_WORKSPACE/source/weeder.toml
+          working-directory: ${{ env.PKGDIR_servant_client }}
+      - name: "weeder: servant-docs"
+        uses: freckle/weeder-action@v2
+        if: ${{ env.HCNUMVER < 81000 }}
+        with:
+          ghc-version: ${{ matrix.compilerVersion }}
+          weeder-arguments: --config $GITHUB_WORKSPACE/source/weeder.toml
+          working-directory: ${{ env.PKGDIR_servant_docs }}
+      - name: unconstrained build
+        run: |
+          rm -f cabal.project.local
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
+      - name: save cache
+        uses: actions/cache/save@v4
+        if: always()
+        with:
+          key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
+          path: ~/.cabal/store

fixtures/weeder.project

@@ -0,0 +1,4 @@
+packages:
+  servant,
+  servant-client,
+  servant-docs,

src/HaskellCI/Auxiliary.hs

@@ -49,6 +49,7 @@ data Auxiliary = Auxiliary
     , anyJobUsesPreviewGHC    :: Bool
     , runHaddock              :: Bool
     , haddockFlags            :: String
+    , runWeeder               :: Bool
     }
 
 auxiliary :: Config -> Project URI Void Package -> JobVersions -> Auxiliary
@@ -84,6 +85,8 @@ auxiliary Config {..} prj JobVersions {..} = Auxiliary {..}
         ComponentsAll  -> " --haddock-all"
         ComponentsLibs -> ""
 
+    runWeeder = not (equivVersionRanges C.noVersion cfgWeeder)
+
     extraCabalProjectFields :: FilePath -> [C.PrettyField ()]
     extraCabalProjectFields rootdir = buildList $ do
         -- generate package fields for URI packages.

src/HaskellCI/Config/Grammar.hs

@@ -90,6 +90,8 @@ configGrammar = Config
         ^^^ metahelp "RANGE" "Haddock step"
     <*> optionalFieldDef   "haddock-components"                                             (field @"cfgHaddockComponents") defaultConfig
         ^^^ metahelp "all|libs" "Haddock components"
+    <*> rangeField           "weeder"                                                       (field @"cfgWeeder") defaultConfig
+        ^^^ metahelp "RANGE" "Weeder step"
     <*> rangeField           "no-tests-no-benchmarks"                                       (field @"cfgNoTestsNoBench") defaultConfig
         ^^^ metahelp "RANGE" "Build without tests and benchmarks"
     <*> rangeField            "unconstrained"                                               (field @"cfgUnconstrainted") defaultConfig

src/HaskellCI/Config/Initial.hs

@@ -37,6 +37,7 @@ initialConfig = Config
     , cfgBenchmarks          = anyVersion
     , cfgHaddock             = anyVersion
     , cfgHaddockComponents   = ComponentsAll
+    , cfgWeeder              = noVersion
     , cfgNoTestsNoBench      = anyVersion
     , cfgUnconstrainted      = anyVersion
     , cfgHeadHackage         = defaultHeadHackage