Support for weeder step

haskell-CI · Jul 18, 2024 · 5d035ba · 5d035ba
1 parent 5e5b27d
commit 5d035ba
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 1 deletion.
diff --git a/cabal.haskell-ci b/cabal.haskell-ci
@@ -23,7 +23,7 @@ ghc-head: False
 -- remove cabal noise from test output
 -- cabal-noise: False
 
--- Build tests. In addition to True and False you may specify
+-- Build tests. Alternatively to True and False you may specify
 -- a version range, e.g. >= 8.0 to build tests only in some jobs.
 tests: True
 

diff --git a/src/HaskellCI/Auxiliary.hs b/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.

diff --git a/src/HaskellCI/Config/Grammar.hs b/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

diff --git a/src/HaskellCI/Config/Initial.hs b/src/HaskellCI/Config/Initial.hs
@@ -37,6 +37,7 @@ initialConfig = Config
     , cfgBenchmarks          = anyVersion
     , cfgHaddock             = anyVersion
     , cfgHaddockComponents   = ComponentsAll
+    , cfgWeeder              = anyVersion
     , cfgNoTestsNoBench      = anyVersion
     , cfgUnconstrainted      = anyVersion
     , cfgHeadHackage         = defaultHeadHackage

diff --git a/src/HaskellCI/Config/Type.hs b/src/HaskellCI/Config/Type.hs
@@ -42,6 +42,7 @@ data Config = Config
     , cfgBenchmarks          :: !VersionRange
     , cfgHaddock             :: !VersionRange
     , cfgHaddockComponents   :: !Components
+    , cfgWeeder              :: !VersionRange
     , cfgNoTestsNoBench      :: !VersionRange
     , cfgUnconstrainted      :: !VersionRange
     , cfgHeadHackage         :: !VersionRange

diff --git a/src/HaskellCI/GitHub.hs b/src/HaskellCI/GitHub.hs
@@ -536,6 +536,13 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
             -- disable-documentation disables docs in deps: https://github.com/haskell/cabal/issues/7462
             sh_if range $ "$CABAL v2-haddock --disable-documentation" ++ haddockFlags ++ " $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all"
 
+        when runWeeder $
+            for_ pkgs $ \Pkg{pkgName} -> do
+                githubUses "weeder" "freckle/weeder-action@v2" $ buildList $ do
+                    item ("ghc-version", "${{ matrix.compilerVersion }}")
+                    item ("weeder-arguments", "--config $GITHUB_WORKSPACE/source/weeder.toml")
+                    item ("working-directory", pkgNameDirVariable pkgName)
+
         -- unconstrained build
         unless (equivVersionRanges C.noVersion cfgUnconstrainted) $ githubRun "unconstrained build" $ do
             let range = Range cfgUnconstrainted