Merge pull request #485 from RyanGlScott/cabal-docspec-constraint-set

Allow running cabal-docspec in constraint-sets

Author: phadej

cabal.haskell-ci

@@ -101,6 +101,7 @@ constraint-set deepseq-1.4
 
   -- tests: False
   -- run-tests: False
+  -- docspec: False
   -- benchmarks: False
   haddock: True
 

haskell-ci.cabal

@@ -1,6 +1,6 @@
 cabal-version:      2.2
 name:               haskell-ci
-version:            0.11.20210221
+version:            0.11.20210222
 synopsis:           Cabal package script generator for Travis-CI
 description:
   Script generator (@haskell-ci@) for [Travis-CI](https://travis-ci.org/) for continuous-integration testing of Haskell Cabal packages.

src/HaskellCI/Config/ConstraintSet.hs

@@ -16,13 +16,14 @@ data ConstraintSet = ConstraintSet
     , csConstraints :: [String] -- we parse these simply as strings
     , csTests       :: Bool
     , csRunTests    :: Bool
+    , csDocspec     :: Bool
     , csBenchmarks  :: Bool
     , csHaddock     :: Bool
     }
   deriving (Show, Generic)
 
 emptyConstraintSet :: String -> ConstraintSet
-emptyConstraintSet n = ConstraintSet n anyVersion [] False False False False
+emptyConstraintSet n = ConstraintSet n anyVersion [] False False False False False
 
 -------------------------------------------------------------------------------
 -- Grammar
@@ -37,5 +38,6 @@ constraintSetGrammar name = ConstraintSet name
     <*> C.monoidalFieldAla "constraints" (C.alaList' C.CommaVCat NoCommas) (field @"csConstraints")
     <*> C.booleanFieldDef  "tests"                                         (field @"csTests") False
     <*> C.booleanFieldDef  "run-tests"                                     (field @"csRunTests") False
+    <*> C.booleanFieldDef  "docspec"                                       (field @"csDocspec") False
     <*> C.booleanFieldDef  "benchmarks"                                    (field @"csBenchmarks") False
     <*> C.booleanFieldDef  "haddock"                                       (field @"csHaddock") False

src/HaskellCI/GitHub.hs

@@ -385,11 +385,9 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
 
         -- docspec
         when docspecEnabled $ githubRun "docspec" $ do
-            let docspecOptions = cfgDocspecOptions cfgDocspec
-            let range = Range (cfgDocspecEnabled cfgDocspec)
             -- we need to rebuild, if tests screwed something.
-            sh_if range "$CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all"
-            sh_if range $ unwords $ "cabal-docspec $ARG_COMPILER" : docspecOptions
+            sh_if docspecRange "$CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all"
+            sh_if docspecRange cabalDocspec
 
         -- hlint
         when (cfgHLintEnabled cfgHLint) $ githubRun "hlint" $ do
@@ -440,6 +438,8 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
             let allFlags        = unwords (testFlag : benchFlag : constraintFlags)
 
             sh_cs $ "$CABAL v2-build $ARG_COMPILER " ++ allFlags ++ " all"
+            when (docspecEnabled && csDocspec cs) $
+                sh_cs' docspecRange cabalDocspec
             when (csRunTests cs) $
                 sh_cs' hasTests $ "$CABAL v2-test $ARG_COMPILER " ++ allFlags ++ " all"
             when (hasLibrary && csHaddock cs) $
@@ -555,6 +555,14 @@ makeGitHub _argv config@Config {..} gitconfig prj jobs@JobVersions {..} = do
     withHaddock :: String
     withHaddock = "--with-haddock $HADDOCK"
 
+    cabalDocspec :: String
+    cabalDocspec =
+      let docspecOptions = cfgDocspecOptions cfgDocspec in
+      unwords $ "cabal-docspec $ARG_COMPILER" : docspecOptions
+
+    docspecRange :: CompilerRange
+    docspecRange = Range (cfgDocspecEnabled cfgDocspec)
+
 postgresService :: GitHubService
 postgresService = GitHubService
     { ghServImage   = "postgres:10"