[ignore]

.github/workflows/bootstrap.skip.yml

@@ -6,7 +6,7 @@ name: Bootstrap Skip
 # to the docs, since these jobs take a long time to complete without providing any benefit.
 # We therefore use path-filtering in the workflow triggers for the bootstrap jobs, namely
 # "paths-ignore: doc/**". But the "Bootstrap post job" is a required job, therefore a PR cannot
-# be merged unless the "Bootstrap post job" completes succesfully, which it doesn't do if we 
+# be merged unless the "Bootstrap post job" completes succesfully, which it doesn't do if we
 # filter it out.
 #
 # The solution: We use a second job with the same name which always returns the exit code 0.

.github/workflows/bootstrap.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ghc: ["8.10.7", "9.0.2", "9.2.8", "9.4.8", "9.6.4", "9.8.1"]
+        ghc: ["9.0.2", "9.2.8", "9.4.8", "9.6.4", "9.8.2"]
         include:
           - os: macos-latest
             ghc: "9.2.8"
@@ -52,28 +52,18 @@ jobs:
           restore-keys: bootstrap-${{ runner.os }}-${{ matrix.ghc }}-20221115-
 
       - uses: actions/checkout@v4
-      # See https://github.com/haskell/cabal/pull/8739
-      - name: Sudo chmod to permit ghcup to update its cache
-        run: |
-          if [[ "${{ runner.os }}" == "Linux" ]]; then
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo mkdir -p /usr/local/.ghcup/cache
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo chown -R $USER /usr/local/.ghcup
-            sudo chmod -R 777 /usr/local/.ghcup
-          fi
+      - uses: haskell-actions/setup@v2
+        with:
+          ghc-version: ${{ matrix.ghc }}
+
       - name: bootstrap.py
         run: |
           GHC_VERSION=${{ matrix.ghc }}
-          ghcup --version
-          ghcup config set cache true
-          ghcup install ghc $GHC_VERSION
-
           # Fetch the bootstrap sources (we use linux dependencies also on macos)
-          python3 bootstrap/bootstrap.py -w $(ghcup whereis ghc $GHC_VERSION) -d bootstrap/linux-$GHC_VERSION.json fetch
+          python3 bootstrap/bootstrap.py -d bootstrap/linux-$GHC_VERSION.json fetch
 
           # Bootstrap using the bootstrap sources
-          python3 bootstrap/bootstrap.py -w $(ghcup whereis ghc $GHC_VERSION) --bootstrap-sources bootstrap-sources.tar.gz
+          python3 bootstrap/bootstrap.py --bootstrap-sources bootstrap-sources.tar.gz
 
       - name: Smoke test
         run: |

.github/workflows/changelogs.yml

@@ -1,4 +1,4 @@
-name: Assorted
+name: Changelogs
 
 on:
   push:
@@ -25,41 +25,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Set PATH
-        # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
-        run: |
-          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
-      - uses: actions/cache@v3
-        with:
-          path: ~/.cabal/store
-          key: linux-store-changelogs
-      # See https://github.com/haskell/cabal/pull/8739
-      - name: Sudo chmod to permit ghcup to update its cache
-        run: |
-          if [[ "${{ runner.os }}" == "Linux" ]]; then
-            sudo mkdir -p /usr/local/.ghcup/cache
-            sudo chown -R $USER /usr/local/.ghcup
-            sudo chmod -R 777 /usr/local/.ghcup
-          fi
-      - name: ghcup
-        run: |
-          ghcup config set cache true
-          ghcup install ghc recommended
-          ghcup set ghc recommended
-      - name: Update Hackage index
-        run: cabal v2-update
-      # Cannot install it from tarball due to
-      # https://github.com/haskell/cabal/issues/7360
-      - uses: actions/checkout@v4
-        with:
-          repository: "fgaz/changelog-d"
-          path: "changelog-d"
+
       - name: Install changelog-d
         run: |
-          pushd changelog-d
-          cabal v2-install
-          popd
-      - uses: actions/checkout@v4
+          curl --create-dirs -o "$HOME/.local/bin/changelog-d" "https://codeberg.org/fgaz/changelog-d/releases/download/v1.0/changelog-d-v1.0-x86_64-linux"
+          chmod +x "$HOME/.local/bin/changelog-d"
+          # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Checkout cabal sources
+        uses: actions/checkout@v4
+
       - name: Run changelog-d
         run: |
           changelog-d changelog.d

.github/workflows/lint.yml

@@ -11,7 +11,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: haskell-actions/hlint-setup@v2
       with:
-        version: "3.5"
+        version: "3.8"
     - uses: haskell-actions/hlint-run@v2
       with:
         path: "."

.github/workflows/quick-jobs.yml

@@ -14,87 +14,109 @@ on:
     types:
       - created
 
+env:
+  GHC_FOR_QUICK_JOBS: 9.6.5
+
 jobs:
   meta:
     name: Meta checks
     runs-on: ubuntu-latest
+    env:
+      cabal_build: >-
+        cabal build --builddir=dist-newstyle-meta --project-file=cabal.meta.project
+        gen-cabal-macros
+        gen-paths-module
+        gen-spdx
+        gen-spdx-exc
     # This job is not run in a container, any recent GHC should be fine
     steps:
-      - name: Set PATH
-        # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
-        run: |
-          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
-      - uses: actions/cache@v3
-        with:
-          path: ~/.cabal/store
-          key: linux-store-meta
-      # See https://github.com/haskell/cabal/pull/8739
-      - name: Sudo chmod to permit ghcup to update its cache
-        run: |
-          if [[ "${{ runner.os }}" == "Linux" ]]; then
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo mkdir -p /usr/local/.ghcup/cache
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo chown -R $USER /usr/local/.ghcup
-            sudo chmod -R 777 /usr/local/.ghcup
-          fi
       - name: ghcup
         run: |
           ghcup --version
           ghcup config set cache true
-          ghcup install ghc recommended
-          ghcup set ghc recommended
+          ghcup install ghc $GHC_FOR_QUICK_JOBS
+          ghcup set ghc $GHC_FOR_QUICK_JOBS
+      - name: Haskell versions
+        run: |
+          ghc --version
+          cabal --version
       - name: Update Hackage index
         run: cabal v2-update
-      - name: Install alex
-        run: cabal v2-install alex --constraint='alex ==3.2.7.3'
       - uses: actions/checkout@v4
+      - name: Generate build plan for correct cache key
+        run: ${{ env.cabal_build }} --dry-run
+      - name: Restore cached dependencies
+        uses: actions/cache/restore@v4
+        id: cache
+        with:
+          path: ~/.local/state/cabal
+          key: linux-store-meta-${{ hashfiles('dist-newstyle-meta/cache/plan.json') }}
+          restore-keys: linux-store-meta-
+      - name: Build tools
+        run: ${{ env.cabal_build }}
       - name: Regenerate files
         run: |
-          make -B lexer
           make -B spdx
           make -B templates
       - name: Check that diff is clean
         run: |
           git status > /dev/null
           git diff-files -p --exit-code
+      - name: Cache dependencies
+        uses: actions/cache/save@v4
+        if: always() && steps.cache.outputs.cache-hit != 'true'
+        with:
+          path: ~/.local/state/cabal
+          key: ${{ steps.cache.outputs.cache-primary-key }}
+
   doctest:
     name: Doctest Cabal
     runs-on: ubuntu-latest
     steps:
-      - name: Set PATH
+      # It is complicated to get a proper cache key for the dependencies of a package
+      # (here: doctest) that we just `cabal install`.
+      # So, as a heuristics we update the cache once per day.
+      # Updating it with each run would be an alternative, but we a short of cache space,
+      # and this would generate too many new caches.
+      - name: Use date as cache key
         run: |
-          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
-      - uses: actions/cache@v3
+          echo "DATE=$(date +'%Y-%m-%d')" >> "${GITHUB_ENV}"
+      - name: Restore cached dependencies
+        uses: actions/cache/restore@v4
+        id: cache
         with:
-          path: ~/.cabal/store
-          key: linux-store-doctest
-      # See https://github.com/haskell/cabal/pull/8739
-      - name: Sudo chmod to permit ghcup to update its cache
-        run: |
-          if [[ "${{ runner.os }}" == "Linux" ]]; then
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo mkdir -p /usr/local/.ghcup/cache
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo chown -R $USER /usr/local/.ghcup
-            sudo chmod -R 777 /usr/local/.ghcup
-          fi
+          path: ~/.local/state/cabal
+          key: linux-store-doctest-${{ env.DATE }}
+          restore-keys: linux-store-doctest
       - name: ghcup
         run: |
           ghcup --version
           ghcup config set cache true
-          ghcup install ghc --set recommended
-          ghcup install cabal --set latest
+          ghcup install ghc $GHC_FOR_QUICK_JOBS
+          ghcup set ghc $GHC_FOR_QUICK_JOBS
+      - name: Haskell versions
+        run: |
+          ghc --version
+          cabal --version
       - name: Update Hackage index
         run: cabal v2-update
       - uses: actions/checkout@v4
       - name: Install doctest
         run: make doctest-install
       - name: Doctest
         run: make doctest
+      - name: Cache dependencies
+        if: always() && steps.cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+          path: ~/.local/state/cabal
+          key: ${{ steps.cache.outputs.cache-primary-key }}
+
   buildinfo:
     name: Check Field Syntax Reference
     runs-on: ubuntu-latest
+    env:
+      cabal_build: cabal build buildinfo-reference-generator
     steps:
       - name: Set PATH
         run: |
@@ -103,25 +125,60 @@ jobs:
         with:
           path: ~/.cabal/store
           key: linux-store-buildinfo-doc-diff
-      # See https://github.com/haskell/cabal/pull/8739
-      - name: Sudo chmod to permit ghcup to update its cache
-        run: |
-          if [[ "${{ runner.os }}" == "Linux" ]]; then
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo mkdir -p /usr/local/.ghcup/cache
-            sudo ls -lah /usr/local/.ghcup/cache
-            sudo chown -R $USER /usr/local/.ghcup
-            sudo chmod -R 777 /usr/local/.ghcup
-          fi
       - name: ghcup
         run: |
           ghcup --version
           ghcup config set cache true
-          ghcup install ghc --set recommended
-          ghcup install cabal --set latest
+          ghcup install ghc $GHC_FOR_QUICK_JOBS
+          ghcup set ghc $GHC_FOR_QUICK_JOBS
+      - name: Haskell versions
+        run: |
+          ghc --version
+          cabal --version
       - name: Update Hackage index
         run: cabal v2-update
       - uses: actions/checkout@v4
+      - name: Generate build plan for correct cache key
+        run: ${{ env.cabal_build }} --dry-run
+      - name: Restore cached dependencies
+        uses: actions/cache/restore@v4
+        id: cache
+        with:
+          path: ~/.local/state/cabal
+          key: linux-store-buildinfo-doc-diff-${{ hashfiles('dist-newstyle/cache/plan.json') }}
+          restore-keys: linux-store-buildinfo-doc-diff
+      - name: Build buildinfo-reference-generator
+        run: ${{ env.cabal_build }}
       - name: Are buildinfo docs up to date?
         run: make doc/buildinfo-fields-reference.rst
+      - name: Cache dependencies
+        uses: actions/cache/save@v4
+        if: always() && steps.cache.outputs.cache-hit != 'true'
+        with:
+          path: ~/.local/state/cabal
+          key: ${{ steps.cache.outputs.cache-primary-key }}
 
+  release-project:
+    name: Check Release Project
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set PATH
+        run: |
+          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
+      - name: ghcup
+        run: |
+          ghcup --version
+          ghcup config set cache true
+          ghcup install ghc $GHC_FOR_QUICK_JOBS
+          ghcup set ghc $GHC_FOR_QUICK_JOBS
+      - name: Haskell versions
+        run: |
+          ghc --version
+          cabal --version
+      - name: Update Hackage Index
+        run: cabal v2-update
+      - uses: actions/checkout@v4
+      - name: Check Release with Pinned Hackage
+        run: cabal build all --dry-run --project-file=cabal.release.project
+      - name: Check Release with Latest Hackage
+        run: cabal build all --dry-run --project-file=cabal.release.project --index-state="hackage.haskell.org HEAD"

.github/workflows/users-guide.yml

@@ -15,7 +15,6 @@ on:
     - 'doc/Makefile'
     - 'doc/pyproject.toml'
     - 'doc/requirements.in'
-    - 'doc/requirements.txt'
     - 'doc/*.inc'
     - 'doc/*.py'
     - 'doc/*.rst'
@@ -26,7 +25,6 @@ on:
     - 'doc/Makefile'
     - 'doc/pyproject.toml'
     - 'doc/requirements.in'
-    - 'doc/requirements.txt'
     - 'doc/*.inc'
     - 'doc/*.py'
     - 'doc/*.rst'
@@ -58,6 +56,14 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Install pip-compile
+      run: |
+        pip install pip-tools
+
+    - name: Create requirements.txt from requirements.in
+      run: |
+        make users-guide-requirements
+
     # Subsumed by make users-guide
     # - name: Install dependencies
     #   run: |

.github/workflows/validate.skip.yml

@@ -6,7 +6,7 @@ name: Validate Skip
 # to the docs, since these jobs take a long time to complete without providing any benefit.
 # We therefore use path-filtering in the workflow triggers for the validate jobs, namely
 # "paths-ignore: doc/**". But the "Validate post job" is a required job, therefore a PR cannot
-# be merged unless the "Validate post job" completes succesfully, which it doesn't do if we 
+# be merged unless the "Validate post job" completes succesfully, which it doesn't do if we
 # filter it out.
 #
 # The solution: We use a second job with the same name which always returns the exit code 0.