Merge pull request #8766 from haskell/mergify/bp/3.10/pr-8747

cabal-install: check: Whitelist doc file extensions (backport #8747)

Cabal/src/Distribution/PackageDescription/Check.hs

@@ -2545,19 +2545,21 @@ checkGlobFiles verbosity pkg root = do
           )
 
     -- Predicate for desirable documentation file on Hackage server
-    isDesirableExtraDocFile :: [FilePath] -> FilePath -> Bool
-    isDesirableExtraDocFile paths path = map toLower basename `elem` paths
+    isDesirableExtraDocFile :: ([FilePath], [FilePath]) -> FilePath -> Bool
+    isDesirableExtraDocFile (basenames, extensions) path =
+      basename `elem` basenames && ext `elem` extensions
       where
-        (basename, _ext) = splitExtension path
+        (basename, ext) = splitExtension (map toLower path)
 
-    -- Changelog patterns
+    -- Changelog patterns (basenames & extensions)
     -- Source: hackage-server/src/Distribution/Server/Packages/ChangeLog.hs
     desirableChangeLog =
       [ "news"
       , "changelog"
       , "change_log"
       , "changes"
       ]
+    desirableChangeLogExtensions = ["", ".txt", ".md", ".markdown", ".rst"]
     -- [TODO] Check readme. Observations:
     --        • Readme is not necessary if package description is good.
     --        • Some readmes exists only for repository browsing.
@@ -2567,7 +2569,7 @@ checkGlobFiles verbosity pkg root = do
     -- -- Readme patterns
     -- -- Source: hackage-server/src/Distribution/Server/Packages/Readme.hs
     -- desirableReadme = ["readme"]
-    desirableDocFiles = desirableChangeLog
+    desirableDocFiles = (desirableChangeLog, desirableChangeLogExtensions)
 
     -- If there's a missing directory in play, since our globs don't
     -- (currently) support disjunction, that will always mean there are no

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotExisting/cabal.test.hs

@@ -1,7 +1,5 @@
 import Test.Cabal.Prelude
 
-import System.Directory (createDirectoryIfMissing)
-
 -- Omitting ChangeLog.md but not README in extra-doc-files
 main = cabalTest $ do
   cabal "check" []

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/.gitignore

@@ -0,0 +1,2 @@
+# Needed for test, to ensure we test the file extension as well.
+!ChangeLog.md~

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V1.12/cabal.test.hs

@@ -1,7 +1,5 @@
 import Test.Cabal.Prelude
 
-import System.Directory (createDirectoryIfMissing)
-
 -- Omitting ChangeLog.md but not README in extra-doc-files
 main = cabalTest $ do
   cabal "check" []

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V3.0/cabal.out

@@ -1,3 +1,3 @@
 # cabal check
 Warning: These warnings may cause trouble when distributing the package:
-Warning: Please consider including the file './ChangeLog.md' in the 'extra-doc-files' section of the .cabal file if it contains useful information for users of the package.
+Warning: Please consider including the file './CHANGELOG.TXT' in the 'extra-doc-files' section of the .cabal file if it contains useful information for users of the package.

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/NotIncluded/V3.0/cabal.test.hs

@@ -1,7 +1,5 @@
 import Test.Cabal.Prelude
 
-import System.Directory (createDirectoryIfMissing)
-
 -- Omitting ChangeLog.md but not README in extra-doc-files
 main = cabalTest $ do
   cabal "check" []

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/WrongField/V1.12/cabal.test.hs

@@ -1,7 +1,5 @@
 import Test.Cabal.Prelude
 
-import System.Directory (createDirectoryIfMissing)
-
 -- Included ChangeLog.md but not in extra-doc-files
 main = cabalTest $ do
   cabal "check" []

cabal-testsuite/PackageTests/Check/PackageFiles/MissingExpectedDocFiles/ChangeLog/WrongField/V3.0/cabal.test.hs

@@ -1,7 +1,5 @@
 import Test.Cabal.Prelude
 
-import System.Directory (createDirectoryIfMissing)
-
 -- Included ChangeLog.md but not in extra-doc-files
 main = cabalTest $ do
   cabal "check" []