Run docspec in CI

cdepillabout · Nov 8, 2021 · 9cc77be · 9cc77be
1 parent 6d2ae0d
commit 9cc77be
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 163 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,11 +17,10 @@ jobs:
           - macOS-latest
         cabal: ["latest"]
         ghc:
-          # - "8.2.2"  # persistent-2.11 doesn't build on ghc-8.2.2
           - "8.4.4"
           - "8.6.5"
           - "8.8.4"
-          - "8.10.4"
+          - "8.10.7"
 
     steps:
     - uses: actions/checkout@v2
@@ -47,6 +46,14 @@ jobs:
     - name: Test
       run: |
         cabal test all --enable-tests
+
+    - name: Fetch cabal-docspec                                       
+      run: |                                                          
+        wget https://github.com/phadej/cabal-extras/releases/download/cabal-docspec-0.0.0.20210111/cabal-docspec-0.0.0.20210111.xz &&
+        unxz cabal-docspec-0.0.0.20210111.xz && mv cabal-docspec-0.0.0.20210111 cabal-docspec
+        chmod +x cabal-docspec                                        
+    - name: Run cabal-docspec                                         
+      run: ./cabal-docspec --check-properties --timeout=30
   stack:
     name: stack ${{ matrix.resolver }}
     runs-on: ubuntu-latest

diff --git a/password-instances/Setup.hs b/password-instances/Setup.hs
diff --git a/password-instances/password-instances.cabal b/password-instances/password-instances.cabal
@@ -12,7 +12,7 @@ maintainer:     [email protected], [email protected]
 copyright:      Copyright (c) Dennis Gosnell, 2019; Felix Paulusma, 2020
 license:        BSD3
 license-file:   LICENSE
-build-type:     Custom
+build-type:     Simple
 extra-source-files:
     README.md
     ChangeLog.md
@@ -21,12 +21,6 @@ source-repository head
   type: git
   location: https://github.com/cdepillabout/password
 
-custom-setup
-  setup-depends:
-      base
-    , Cabal
-    , cabal-doctest  >=1.0.6 && <1.1
-
 library
   hs-source-dirs:
       src
@@ -45,27 +39,7 @@ library
       -Wall
   default-language:
       Haskell2010
-
-test-suite doctests
-  type:
-      exitcode-stdio-1.0
-  hs-source-dirs:
-      test/doctest
-  main-is:
-      doctest.hs
-  ghc-options:
-      -threaded -rtsopts -with-rtsopts=-N
-  build-depends:
-      base >=4.9 && <5
-    , base-compat
-    , doctest
-    , password
-    , password-instances
-    , QuickCheck
-    , quickcheck-instances
-    , template-haskell
-  default-language:
-      Haskell2010
+  x-docspec-extra-packages: QuickCheck quickcheck-instances password password-types
 
 test-suite password-instances-tasty
   type:

diff --git a/password-instances/src/Data/Password/Instances.hs b/password-instances/src/Data/Password/Instances.hs
@@ -48,6 +48,7 @@ import Web.HttpApiData (FromHttpApiData(..), ToHttpApiData(..))
 --
 -- >>> import Data.Aeson (decode)
 -- >>> import Data.Password.Bcrypt (Salt(..), hashPasswordWithSalt, unsafeShowPassword)
+-- >>> import Data.Password.Types
 -- >>> import Database.Persist.Class (PersistField(toPersistValue))
 -- >>> import Web.HttpApiData (parseUrlPiece)
 

diff --git a/password-types/Setup.hs b/password-types/Setup.hs
diff --git a/password-types/password-types.cabal b/password-types/password-types.cabal
@@ -12,17 +12,11 @@ maintainer:     [email protected], [email protected]
 copyright:      Copyright (c) Dennis Gosnell & Felix Paulusma, 2020
 license:        BSD3
 license-file:   LICENSE
-build-type:     Custom
+build-type:     Simple
 extra-source-files:
     README.md
     ChangeLog.md
 
-custom-setup
-  setup-depends:
-      base
-    , Cabal
-    , cabal-doctest  >=1.0.6 && <1.1
-
 source-repository head
   type: git
   location: https://github.com/cdepillabout/password

diff --git a/password/Setup.hs b/password/Setup.hs
diff --git a/password/password.cabal b/password/password.cabal
@@ -41,17 +41,11 @@ maintainer:     [email protected], [email protected]
 copyright:      Copyright (c) Dennis Gosnell, 2019; Felix Paulusma, 2020
 license:        BSD3
 license-file:   LICENSE
-build-type:     Custom
+build-type:     Simple
 extra-source-files:
     README.md
     ChangeLog.md
 
-custom-setup
-  setup-depends:
-      base
-    , Cabal
-    , cabal-doctest  >=1.0.6 && <1.1
-
 source-repository head
   type: git
   location: https://github.com/cdepillabout/password
@@ -81,26 +75,7 @@ library
       -Wall
   default-language:
       Haskell2010
-
-test-suite doctests
-  type:
-      exitcode-stdio-1.0
-  hs-source-dirs:
-      test/doctest
-  main-is:
-      doctest.hs
-  ghc-options:
-      -threaded -O2 -rtsopts -with-rtsopts=-N
-  build-depends:
-      base >=4.9 && <5
-    , base-compat
-    , doctest
-    , password
-    , QuickCheck
-    , quickcheck-instances
-    , template-haskell
-  default-language:
-      Haskell2010
+  x-docspec-extra-packages: QuickCheck quickcheck-instances
 
 test-suite password-tasty
   type: