Merge pull request #613 from haskell-CI/haddock-components

Configurable haddock components

Author: phadej

haskell-ci.cabal

@@ -1,6 +1,6 @@
 cabal-version:      2.2
 name:               haskell-ci
-version:            0.15.20220821
+version:            0.15.20220822
 synopsis:           Cabal package script generator for Travis-CI
 description:
   Script generator (@haskell-ci@) for
@@ -84,6 +84,7 @@ library haskell-ci-internal
     HaskellCI.Cli
     HaskellCI.Compiler
     HaskellCI.Config
+    HaskellCI.Config.Components
     HaskellCI.Config.ConstraintSet
     HaskellCI.Config.CopyFields
     HaskellCI.Config.Docspec

src/HaskellCI/Auxiliary.hs

@@ -27,6 +27,7 @@ import Cabal.Project
 import Cabal.SourceRepo
 import HaskellCI.Compiler
 import HaskellCI.Config
+import HaskellCI.Config.Components
 import HaskellCI.Config.CopyFields
 import HaskellCI.Config.Docspec
 import HaskellCI.Config.Doctest
@@ -46,6 +47,8 @@ data Auxiliary = Auxiliary
     , extraCabalProjectFields :: FilePath -> [C.PrettyField ()]
     , testShowDetails         :: String
     , anyJobUsesHeadHackage   :: Bool
+    , runHaddock              :: Bool
+    , haddockFlags            :: String
     }
 
 auxiliary :: Config -> Project URI Void Package -> JobVersions -> Auxiliary
@@ -72,6 +75,15 @@ auxiliary Config {..} prj JobVersions {..} = Auxiliary {..}
 
     hasLibrary = any (\Pkg{pkgGpd} -> isJust $ C.condLibrary pkgGpd) pkgs
 
+    runHaddock = not (equivVersionRanges C.noVersion cfgHaddock)
+        && case cfgHaddockComponents of
+            ComponentsAll  -> True
+            ComponentsLibs -> hasLibrary
+
+    haddockFlags = case cfgHaddockComponents of
+        ComponentsAll  -> " --haddock-all"
+        ComponentsLibs -> ""
+
     extraCabalProjectFields :: FilePath -> [C.PrettyField ()]
     extraCabalProjectFields rootdir = buildList $ do
         -- generate package fields for URI packages.

src/HaskellCI/Config.hs

@@ -23,6 +23,7 @@ import qualified Distribution.Types.Version      as C
 import qualified Distribution.Types.VersionRange as C
 import qualified Text.PrettyPrint                as PP
 
+import HaskellCI.Config.Components
 import HaskellCI.Config.ConstraintSet
 import HaskellCI.Config.CopyFields
 import HaskellCI.Config.Docspec
@@ -61,6 +62,7 @@ data Config = Config
     , cfgRunTests            :: !VersionRange
     , cfgBenchmarks          :: !VersionRange
     , cfgHaddock             :: !VersionRange
+    , cfgHaddockComponents   :: !Components
     , cfgNoTestsNoBench      :: !VersionRange
     , cfgUnconstrainted      :: !VersionRange
     , cfgHeadHackage         :: !VersionRange
@@ -129,6 +131,7 @@ configGrammar
        , c (Identity CopyFields)
        , c (Identity Version)
        , c (Identity Natural)
+       , c (Identity Components)
        , c Env, c Folds, c CopyFields, c HeadVersion
        , c (C.List C.FSep (Identity Installed) Installed)
        , Applicative (g DoctestConfig)
@@ -170,6 +173,8 @@ configGrammar = Config
         ^^^ metahelp "RANGE" "Build benchmarks"
     <*> rangeField           "haddock"                                                        (field @"cfgHaddock") anyVersion
         ^^^ metahelp "RANGE" "Haddock step"
+    <*> C.optionalFieldDef   "haddock-components"                                             (field @"cfgHaddockComponents") ComponentsAll
+        ^^^ metahelp "all|libs" "Haddock components"
     <*> rangeField           "no-tests-no-benchmarks"                                         (field @"cfgNoTestsNoBench") anyVersion
         ^^^ metahelp "RANGE" "Build without tests and benchmarks"
     <*> rangeField            "unconstrained"                                                 (field @"cfgUnconstrainted") anyVersion

src/HaskellCI/Config/Components.hs

@@ -0,0 +1,29 @@
+module HaskellCI.Config.Components where
+
+import HaskellCI.Prelude
+
+import qualified Distribution.Compat.CharParsing as C
+import qualified Distribution.Parsec             as C
+import qualified Distribution.Pretty             as C
+import qualified Text.PrettyPrint                as PP
+
+-------------------------------------------------------------------------------
+-- Single action
+-------------------------------------------------------------------------------
+
+data Components
+    = ComponentsAll
+    | ComponentsLibs
+  deriving (Eq, Show)
+
+instance C.Pretty Components where
+    pretty ComponentsAll  = PP.text "all"
+    pretty ComponentsLibs = PP.text "libs"
+
+instance C.Parsec Components where
+    parsec = do
+        t <- C.parsecToken
+        case t of
+            "all"  -> return ComponentsAll
+            "libs" -> return ComponentsLibs
+            _      -> C.unexpected $ "Component " ++ t

src/HaskellCI/GitHub.hs

@@ -563,9 +563,9 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
                 sh_if range "${CABAL} -vnormal check"
 
         -- haddock
-        when (not (equivVersionRanges C.noVersion cfgHaddock)) $ githubRun "haddock" $ do
+        when runHaddock $ githubRun "haddock" $ do
             let range = RangeGHC /\ Range cfgHaddock
-            sh_if range "$CABAL v2-haddock --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all"
+            sh_if range $ "$CABAL v2-haddock" ++ haddockFlags ++ " $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all"
 
         -- unconstrained build
         unless (equivVersionRanges C.noVersion cfgUnconstrainted) $ githubRun "unconstrained build" $ do
@@ -596,7 +596,7 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
             when (csRunTests cs) $
                 sh_cs' hasTests $ "$CABAL v2-test $ARG_COMPILER " ++ allFlags ++ " all"
             when (csHaddock cs) $
-                sh_cs $ "$CABAL v2-haddock --haddock-all $ARG_COMPILER " ++ withHaddock ++ " " ++ allFlags ++ " all"
+                sh_cs $ "$CABAL v2-haddock" ++ haddockFlags ++ " $ARG_COMPILER " ++ withHaddock ++ " " ++ allFlags ++ " all"
 
     -- assembling everything
     return GitHub