Merge branch 'master' of github.com:haskell/cabal into mattp/reuse-glob-information

Author: parsonsmatt

.github/mergify.yml

@@ -62,6 +62,31 @@ pull_request_rules:
       - check-success=Bootstrap post job
       - 'check-success=docs/readthedocs.org:cabal'
 
+  # label when Mergify didn't trigger a merge automatically
+  - actions:
+      label:
+        add:
+          - waiting too long
+    name: Mergify hasn't merged a PR yet
+    conditions:
+      - base=master
+      - -draft
+      - -closed
+      - -merged
+      - '#approved-reviews-by>=2'
+      - '#changes-requested-reviews-by=0'
+      - updated-at<4 days ago
+      - label=merge delay passed
+      # oy
+      # lifted these from branch protection imports
+      - check-success=fourmolu
+      - check-success=hlint
+      - check-success=Meta checks
+      - check-success=Doctest Cabal
+      - check-success=Validate post job
+      - check-success=Bootstrap post job
+      - 'check-success=docs/readthedocs.org:cabal'
+
   # rebase+merge strategy
   - actions:
       queue:
@@ -85,10 +110,6 @@ pull_request_rules:
       - label=merge delay passed
       - '#approved-reviews-by>=2'
       - '-label~=^blocked:'
-      # unlike the others, we need to force this one to be up to date
-      # because it's intended for when Mergify doesn't have permission
-      # to rebase
-      - '#commits-behind=0'
 
   # merge+no rebase strategy
   - actions:

.github/pull_request_template.md

@@ -8,6 +8,7 @@ Include the following checklist in your PR:
 
 * [ ] Patches conform to the [coding conventions](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#other-conventions).
 * [ ] Any changes that could be relevant to users [have been recorded in the changelog](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#changelog).
+  * [ ] [Is the change significant?](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#is-my-change-significant) If so, remember to add `significance: significant` in the changelog file.
 * [ ] The documentation has been updated, if necessary.
 * [ ] [Manual QA notes](https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#qa-notes) have been included.
 * [ ] Tests have been added. (*Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!*)

.github/workflows/check-sdist.yml

@@ -47,7 +47,7 @@ jobs:
         # release of a corresponding Cabal and friends. it can also be short since it's
         # highly unlikely that we are releasing really old branches.
         ghc:
-          ["9.10.1", "9.8.1", "9.6.1"]
+          ["9.12.1", "9.10.1", "9.8.1", "9.6.1"]
 
     steps:
 
@@ -71,9 +71,9 @@ jobs:
           # (don't look at this too closely)
           sdist="$(ls dist-newstyle/sdist/cabal-install-*.tar.gz | sed -n '\,^dist-newstyle/sdist/cabal-install-[0-9.]*\.tar\.gz$,{;p;q;}')"
           # extract the cabal-install major version
-          ver="$(echo "$sdist" | sed -n 's,^dist-newstyle/sdist/cabal-install-\([0-9][0-9]*\.[0-9][0-9]*\)\.[0-9.]*$,\1,p')"
+          ver="$(echo "$sdist" | sed -n 's,^dist-newstyle/sdist/cabal-install-\([0-9][0-9]*\.[0-9][0-9]*\)\.[0-9.]*\.tar\.gz$,\1,p')"
           # dunno if this will ever be extended to freebsd, but grep -q is a gnu-ism
-          if ghc-pkg --global --simple-output list Cabal | grep "^Cabal-$cbl\\." >/dev/null; then
+          if ghc-pkg --global --simple-output list Cabal | grep "^Cabal-$ver\\." >/dev/null; then
             # sigh, someone broke installing from tarballs
             rm -rf cabal*.project Cabal Cabal-syntax cabal-install-solver cabal-install
             tar xfz "$sdist"

.github/workflows/format.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: haskell-actions/run-fourmolu@v10
+    - uses: haskell-actions/run-fourmolu@v11
       with:
         version: "0.12.0.0"
         pattern: |

.github/workflows/typos.yml

@@ -0,0 +1,32 @@
+name: Typos
+
+on:
+  pull_request:
+  push:
+    branches: ["master"]
+
+env:
+  TYPOS_VER: v1.28.1
+  TYPOS_PLATFORM: x86_64-unknown-linux-musl
+
+jobs:
+  typos:
+    defaults:
+      run:
+        shell: bash
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - run: |
+        wget -q https://github.com/crate-ci/typos/releases/download/${{ env.TYPOS_VER }}/typos-${{ env.TYPOS_VER }}-${{ env.TYPOS_PLATFORM }}.tar.gz
+        tar -xf typos-${{ env.TYPOS_VER }}-${{ env.TYPOS_PLATFORM }}.tar.gz --one-top-level=typos-${{ env.TYPOS_VER }}
+        mkdir -p "$HOME/.local/bin"
+        mv typos-${{ env.TYPOS_VER }} "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}"
+        chmod +x "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}/typos"
+        echo "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}" >> $GITHUB_PATH
+
+    - run: make users-guide-typos
+    - run: make markdown-typos

.github/workflows/validate.yml

@@ -80,8 +80,9 @@ jobs:
         # support, so the PR *must* have a changelog entry.
         ghc:
           [
+            "9.12.1",
             "9.10.1",
-            "9.8.2",
+            "9.8.4",
             "9.6.6",
             "9.4.8",
             "9.2.8",
@@ -192,12 +193,6 @@ jobs:
           fi
           echo "FLAGS=$FLAGS" >> "$GITHUB_ENV"
 
-      - name: Validate print-config
-        run: sh validate.sh $FLAGS -s print-config
-
-      - name: Validate print-tool-versions
-        run: sh validate.sh $FLAGS -s print-tool-versions
-
       - name: Validate build
         run: sh validate.sh $FLAGS -s build
 
@@ -454,9 +449,6 @@ jobs:
       - name: Untar the cabal executable
         run: tar -xzf "./cabal-head/cabal-head-${{ runner.os }}-$CABAL_ARCH.tar.gz" -C cabal-head
 
-      - name: print-config using cabal HEAD
-        run: sh validate.sh ${{ env.COMMON_FLAGS }} --with-cabal ./cabal-head/cabal -s print-config
-
       # We dont use cache to force a build with a fresh store dir and build dir
       # This way we check cabal can build all its dependencies
       - name: Build using cabal HEAD
@@ -473,11 +465,17 @@ jobs:
     needs: [validate, validate-old-ghcs, build-alpine, dogfooding]
 
     steps:
-      # for now this is hardcoded. is there a better way?
+      - uses: liudonghua123/delete-release-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          release_name: 'cabal-head'
+
       - uses: actions/download-artifact@v4
         with:
           pattern: cabal-*
           path: binaries
+          merge-multiple: true
 
       - name: Create GitHub prerelease
         uses: softprops/action-gh-release@v2
@@ -490,18 +488,25 @@ jobs:
     name: Create a GitHub LTS prerelease with the binary artifacts
     runs-on: ubuntu-latest
     # The LTS branch is hardcoded for now, update it on a new LTS!
-    # if: github.ref == 'refs/heads/3.12'
+    if: github.ref == 'refs/heads/3.12'
     permissions:
       contents: write
 
     # IMPORTANT! Any job added to the workflow should be added here too
     needs: [validate, validate-old-ghcs, build-alpine, dogfooding]
 
     steps:
+    - uses: liudonghua123/delete-release-action@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        release_name: 'cabal-lts-head'
+
     - uses: actions/download-artifact@v4
       with:
         pattern: cabal-*
         path: binaries
+        merge-multiple: true
 
     - run: |
         # bash-ism, but we forced bash above
@@ -510,10 +515,7 @@ jobs:
           mv "$f" "cabal-lts-${f##cabal-}"
         done
 
-    - run: echo ${{ github.ref }}
-
     - name: Create GitHub prerelease
-      if: github.ref == 'refs/heads/3.12'
       uses: softprops/action-gh-release@v2
       with:
         tag_name: cabal-lts-head

.hlint.yaml

@@ -1,8 +1,8 @@
 # Warnings currently triggered by your code
 - ignore: {name: "Avoid NonEmpty.unzip"} # 1 hint
-- ignore: {name: "Avoid lambda"} # 46 hints
+- ignore: {name: "Avoid lambda"} # 47 hints
 - ignore: {name: "Avoid lambda using `infix`"} # 22 hints
-- ignore: {name: "Eta reduce"} # 116 hints
+- ignore: {name: "Eta reduce"} # 124 hints
 - ignore: {name: "Evaluate"} # 10 hints
 - ignore: {name: "Functor law"} # 10 hints
 - ignore: {name: "Fuse concatMap/map"} # 3 hints
@@ -16,68 +16,67 @@
 - ignore: {name: "Monoid law, right identity"} # 3 hints
 - ignore: {name: "Move filter"} # 4 hints
 - ignore: {name: "Move guards forward"} # 4 hints
-- ignore: {name: "Redundant $"} # 175 hints
+- ignore: {name: "Redundant $"} # 179 hints
 - ignore: {name: "Redundant $!"} # 1 hint
 - ignore: {name: "Redundant <$>"} # 16 hints
 - ignore: {name: "Redundant =="} # 1 hint
-- ignore: {name: "Redundant bracket"} # 232 hints
+- ignore: {name: "Redundant bracket"} # 239 hints
 - ignore: {name: "Redundant fmap"} # 1 hint
 - ignore: {name: "Redundant guard"} # 2 hints
-- ignore: {name: "Redundant if"} # 3 hints
+- ignore: {name: "Redundant if"} # 6 hints
 - ignore: {name: "Redundant lambda"} # 19 hints
 - ignore: {name: "Redundant multi-way if"} # 1 hint
-- ignore: {name: "Redundant return"} # 7 hints
-- ignore: {name: "Replace case with fromMaybe"} # 5 hints
+- ignore: {name: "Redundant return"} # 9 hints
+- ignore: {name: "Replace case with fromMaybe"} # 6 hints
 - ignore: {name: "Replace case with maybe"} # 10 hints
-- ignore: {name: "Unused LANGUAGE pragma"} # 167 hints
 - ignore: {name: "Use $>"} # 5 hints
 - ignore: {name: "Use ++"} # 4 hints
-- ignore: {name: "Use :"} # 25 hints
+- ignore: {name: "Use :"} # 30 hints
 - ignore: {name: "Use <$"} # 2 hints
-- ignore: {name: "Use <$>"} # 86 hints
+- ignore: {name: "Use <$>"} # 87 hints
 - ignore: {name: "Use <&>"} # 14 hints
-- ignore: {name: "Use <=<"} # 5 hints
+- ignore: {name: "Use <=<"} # 4 hints
 - ignore: {name: "Use =<<"} # 7 hints
 - ignore: {name: "Use =="} # 3 hints
 - ignore: {name: "Use >=>"} # 3 hints
 - ignore: {name: "Use ?~"} # 1 hint
 - ignore: {name: "Use Down"} # 3 hints
 - ignore: {name: "Use Just"} # 2 hints
 - ignore: {name: "Use bimap"} # 7 hints
-- ignore: {name: "Use camelCase"} # 96 hints
+- ignore: {name: "Use camelCase"} # 98 hints
 - ignore: {name: "Use catMaybes"} # 3 hints
-- ignore: {name: "Use concatMap"} # 1 hint
+- ignore: {name: "Use concatMap"} # 2 hints
 - ignore: {name: "Use const"} # 36 hints
 - ignore: {name: "Use elem"} # 2 hints
-- ignore: {name: "Use fewer imports"} # 19 hints
+- ignore: {name: "Use fewer imports"} # 13 hints
 - ignore: {name: "Use first"} # 4 hints
-- ignore: {name: "Use fmap"} # 24 hints
+- ignore: {name: "Use fmap"} # 26 hints
 - ignore: {name: "Use fold"} # 1 hint
 - ignore: {name: "Use for"} # 1 hint
 - ignore: {name: "Use forM_"} # 1 hint
-- ignore: {name: "Use fromMaybe"} # 1 hint
+- ignore: {name: "Use fromMaybe"} # 4 hints
 - ignore: {name: "Use fromRight"} # 1 hint
 - ignore: {name: "Use fst"} # 1 hint
-- ignore: {name: "Use if"} # 4 hints
+- ignore: {name: "Use if"} # 2 hints
 - ignore: {name: "Use infix"} # 20 hints
 - ignore: {name: "Use isAsciiLower"} # 2 hints
 - ignore: {name: "Use isAsciiUpper"} # 2 hints
 - ignore: {name: "Use isDigit"} # 2 hints
 - ignore: {name: "Use isJust"} # 1 hint
 - ignore: {name: "Use isNothing"} # 1 hint
-- ignore: {name: "Use lambda-case"} # 47 hints
+- ignore: {name: "Use lambda-case"} # 55 hints
 - ignore: {name: "Use lefts"} # 1 hint
-- ignore: {name: "Use list comprehension"} # 16 hints
+- ignore: {name: "Use list comprehension"} # 18 hints
 - ignore: {name: "Use list literal"} # 3 hints
 - ignore: {name: "Use list literal pattern"} # 11 hints
 - ignore: {name: "Use map once"} # 7 hints
 - ignore: {name: "Use map with tuple-section"} # 3 hints
 - ignore: {name: "Use mapMaybe"} # 13 hints
-- ignore: {name: "Use max"} # 1 hint
+- ignore: {name: "Use max"} # 2 hints
 - ignore: {name: "Use maybe"} # 8 hints
 - ignore: {name: "Use minimumBy"} # 1 hint
 - ignore: {name: "Use newtype instead of data"} # 26 hints
-- ignore: {name: "Use notElem"} # 8 hints
+- ignore: {name: "Use notElem"} # 9 hints
 - ignore: {name: "Use null"} # 2 hints
 - ignore: {name: "Use record patterns"} # 16 hints
 - ignore: {name: "Use replicateM"} # 1 hint
@@ -88,17 +87,30 @@
 - ignore: {name: "Use traverse"} # 1 hint
 - ignore: {name: "Use tuple-section"} # 28 hints
 - ignore: {name: "Use typeRep"} # 2 hints
-- ignore: {name: "Use unless"} # 20 hints
+- ignore: {name: "Use uncurry"} # 1 hint
+- ignore: {name: "Use unless"} # 22 hints
 - ignore: {name: "Use unwords"} # 8 hints
-- ignore: {name: "Use void"} # 22 hints
+- ignore: {name: "Use void"} # 23 hints
 - ignore: {name: "Use when"} # 1 hint
-- ignore: {name: "Use uncurry"} # 1 hint
 
 - arguments:
     - --ignore-glob=Cabal-syntax/src/Distribution/Fields/Lexer.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/BuildWays/q/app/Main.hs
     - --ignore-glob=cabal-testsuite/PackageTests/CmmSources/src/Demo.hs
     - --ignore-glob=cabal-testsuite/PackageTests/CmmSourcesDyn/src/Demo.hs
     - --ignore-glob=cabal-testsuite/PackageTests/CmmSourcesExe/src/Demo.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/NewBuild/CmdRun/Script/script.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptLiterate/script.lhs
+    - --ignore-glob=cabal-testsuite/PackageTests/Regression/T5309/lib/Bio/Character/Exportable/Class.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/SetupHooks/SetupHooksC2HsRules/SetupHooks.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/SetupHooks/SetupHooksDuplicateRuleId/SetupHooks.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/SetupHooks/SetupHooksInvalidRuleOutputIndex/SetupHooks.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/SetupHooks/SetupHooksRuleOrdering/SetupHooks.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/SetupHooks/SetupHooksUnusedRules/SetupHooks.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/TemplateHaskell/dynamic/TH.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/TemplateHaskell/profiling/TH.hs
+    - --ignore-glob=cabal-testsuite/PackageTests/TemplateHaskell/vanilla/TH.hs
     - --ignore-glob=templates/Paths_pkg.template.hs
     - --ignore-glob=templates/SPDX.LicenseExceptionId.template.hs
     - --ignore-glob=templates/SPDX.LicenseId.template.hs
+    - --ignore-glob=dist-*

.typos.toml

@@ -0,0 +1,2 @@
+[default]
+extend-ignore-re = ["(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"]

CONTRIBUTING.md

@@ -439,6 +439,18 @@ At release time, the entries will be merged with
 In addition, if you're changing the `.cabal` file format specification you should
 add an entry in `doc/file-format-changelog.rst`.
 
+### Is my change `significant`?
+
+Use your best judgement and if unsure ask other maintainers. If your PR fixes
+a specific ticket, how busy was the discussion there? A new command or option
+most likely warrants a `significance: significant` tag, same with command
+line changes that disrupts the workflow of many users or an API change
+that requires substantial time to integrate in a program.
+
+Put yourself in the shoes of the user: would you appreciate seeing this
+change highlighted in the announcement post or release notes overview? If
+so, add `significance: significant`.
+
 ## Communicating
 
 There are a few main venues of communication:

Cabal-QuickCheck/src/Test/QuickCheck/Instances/Cabal.hs

@@ -1,5 +1,4 @@
 {-# LANGUAGE CPP           #-}
-{-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 module Test.QuickCheck.Instances.Cabal () where