From 395205c0d86efd006bc8ccde7ddeb425dffe2e9e Mon Sep 17 00:00:00 2001
From: Alec Theriault <alec.theriault@gmail.com>
Date: Fri, 20 Sep 2019 03:21:00 -0400
Subject: [PATCH] Fix Travis CI, loosen .cabal bounds (#1089)
Tentatively for the 2.23 release:
* updated Travis CI to work again
* tweaked bounds in the `.cabal` files
* adjusted `extra-source-files` to properly identify test files
---
.travis.yml | 200 +++++++++++++++-----------
haddock-api/haddock-api.cabal | 8 +-
haddock-library/haddock-library.cabal | 16 ++-
haddock.cabal | 13 +-
4 files changed, 135 insertions(+), 102 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index 2417dea916..896087ba9f 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,104 +1,134 @@
-# NOTE: manually changes were made to an otherwise autogenerated script. This is to
-# query GHC CI artifacts instead of going via Herbert's PPA
-#
# This Travis job script has been generated by a script via
#
-# make_travis_yml_2.hs 'haddock.cabal'
+# haskell-ci 'haddock.cabal' '--output' '.travis.yml'
+#
+# For more information, see https://github.com/haskell-CI/haskell-ci
#
-# For more information, see https://github.com/hvr/multi-ghc-travis
+# version: 0.5.20190916
#
language: c
-sudo: false
-
+dist: xenial
git:
- submodules: false # whether to recursively clone submodules
-
+ # whether to recursively clone submodules
+ submodules: false
cache:
directories:
- $HOME/.cabal/packages
- $HOME/.cabal/store
-
before_cache:
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
# remove files that are regenerated by 'cabal update'
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.*
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/*.json
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.cache
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.tar
- - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.tar.idx
-
- - rm -rfv $HOME/.cabal/packages/head.hackage
-
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
+ - rm -rfv $CABALHOME/packages/head.hackage
matrix:
include:
- - os: linux
- addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head], sources: [hvr-ghc]}}
- env:
- - GHC_ZIP='https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/download?job=validate-x86_64-linux-deb8'
-
+ - compiler: ghc-8.8.1
+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.8.1","cabal-install-3.0"]}}
before_install:
- # Manually install GHC validate artifact
- - travis_retry curl -L $GHC_ZIP --output artifact.zip
- - unzip artifact.zip
- - tar xpf ghc.tar.xz --strip-components 1
- - ./configure
- - sudo make V=1 install
-
- # Set up some vars
- - HC=ghc
- - HCPKG=${HC/ghc/ghc-pkg}
- - PATH=/usr/local/bin:/opt/ghc/bin:/opt/ghc-ppa-tools/bin:$PATH
- - PKGNAME='haddock'
-
+ - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
+ - WITHCOMPILER="-w $HC"
+ - HADDOCK=$(echo "/opt/$CC/bin/haddock" | sed 's/-/\//')
+ - HCPKG="$HC-pkg"
+ - unset CC
+ - CABAL=/opt/ghc/bin/cabal
+ - CABALHOME=$HOME/.cabal
+ - export PATH="$CABALHOME/bin:$PATH"
+ - TOP=$(pwd)
+ - "HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\\d+)\\.(\\d+)\\.(\\d+)(\\.(\\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')"
+ - echo $HCNUMVER
+ - CABAL="$CABAL -vnormal+nowrap+markoutput"
+ - set -o pipefail
+ - |
+ echo 'function blue(s) { printf "\033[0;34m" s "\033[0m " }' >> .colorful.awk
+ echo 'BEGIN { state = "output"; }' >> .colorful.awk
+ echo '/^-----BEGIN CABAL OUTPUT-----$/ { state = "cabal" }' >> .colorful.awk
+ echo '/^-----END CABAL OUTPUT-----$/ { state = "output" }' >> .colorful.awk
+ echo '!/^(-----BEGIN CABAL OUTPUT-----|-----END CABAL OUTPUT-----)/ {' >> .colorful.awk
+ echo ' if (state == "cabal") {' >> .colorful.awk
+ echo ' print blue($0)' >> .colorful.awk
+ echo ' } else {' >> .colorful.awk
+ echo ' print $0' >> .colorful.awk
+ echo ' }' >> .colorful.awk
+ echo '}' >> .colorful.awk
+ - cat .colorful.awk
+ - |
+ color_cabal_output () {
+ awk -f $TOP/.colorful.awk
+ }
+ - echo text | color_cabal_output
install:
- - cabal --version
- - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
- - BENCH=--enable-benchmarks
- - TEST=--enable-tests
- - travis_retry cabal update -v
- - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config
- - rm -fv cabal.project.local
- - rm -f cabal.project.freeze
- # Overlay Hackage Package Index for GHC HEAD: https://github.com/hvr/head.hackage
- - |
- sed -i 's/-- allow-newer: .*/allow-newer: *:base/' ${HOME}/.cabal/config
- for pkg in $($HCPKG list --simple-output); do pkg=$(echo $pkg | sed 's/-[^-]*$//'); sed -i "s/allow-newer: /allow-newer: *:$pkg, /" ${HOME}/.cabal/config; done
-
- echo 'repository head.hackage' >> ${HOME}/.cabal/config
- echo ' url: http://head.hackage.haskell.org/' >> ${HOME}/.cabal/config
- echo ' secure: True' >> ${HOME}/.cabal/config
- echo ' root-keys: 07c59cb65787dedfaef5bd5f987ceb5f7e5ebf88b904bbd4c5cbdeb2ff71b740' >> ${HOME}/.cabal/config
- echo ' 2e8555dde16ebd8df076f1a8ef13b8f14c66bad8eafefd7d9e37d0ed711821fb' >> ${HOME}/.cabal/config
- echo ' 8f79fd2389ab2967354407ec852cbe73f2e8635793ac446d09461ffb99527f6e' >> ${HOME}/.cabal/config
- echo ' key-threshold: 3' >> ${HOME}/.cabal.config
-
- grep -Ev -- '^\s*--' ${HOME}/.cabal/config | grep -Ev '^\s*$'
-
- cabal new-update head.hackage -v
- - travis_retry cabal new-build -w ${HC} ${TEST} ${BENCH} --dep -j2 --allow-newer --constraint 'setup.Cabal installed' all
- - travis_retry cabal new-build -w ${HC} --disable-tests --disable-benchmarks --dep -j2 --allow-newer --constraint 'setup.Cabal installed' all
-
-# Here starts the actual work to be performed for the package under test;
-# any command which exits with a non-zero exit code causes the build to fail.
+ - ${CABAL} --version
+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
+ - TEST=--enable-tests
+ - BENCH=--enable-benchmarks
+ - HEADHACKAGE=false
+ - rm -f $CABALHOME/config
+ - |
+ echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config
+ echo "remote-build-reporting: anonymous" >> $CABALHOME/config
+ echo "write-ghc-environment-files: always" >> $CABALHOME/config
+ echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config
+ echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config
+ echo "world-file: $CABALHOME/world" >> $CABALHOME/config
+ echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config
+ echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config
+ echo "installdir: $CABALHOME/bin" >> $CABALHOME/config
+ echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config
+ echo "store-dir: $CABALHOME/store" >> $CABALHOME/config
+ echo "install-dirs user" >> $CABALHOME/config
+ echo " prefix: $CABALHOME" >> $CABALHOME/config
+ echo "repository hackage.haskell.org" >> $CABALHOME/config
+ echo " url: http://hackage.haskell.org/" >> $CABALHOME/config
+ - |
+ echo "program-default-options" >> $CABALHOME/config
+ echo " ghc-options: $GHCJOBS +RTS -M6G -RTS" >> $CABALHOME/config
+ - cat $CABALHOME/config
+ - rm -fv cabal.project.local cabal.project.freeze
+ - travis_retry ${CABAL} v2-update -v
+ # Generate cabal.project
+ - rm -rf cabal.project.local cabal.project.freeze
+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(haddock)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+ - cat cabal.project || true
+ - cat cabal.project.local || true
+ - if [ -f "./configure.ac" ]; then (cd "." && autoreconf -i); fi
+ - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH} | color_cabal_output
+ - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
+ - rm cabal.project.freeze
+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} --dep -j2 all | color_cabal_output
+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --dep -j2 all | color_cabal_output
script:
- - if [ -f configure.ac ]; then autoreconf -i; fi
- - rm -rf dist/
- - cabal new-sdist # test that a source-distribution can be generated
- - cd dist-newstyle/sdist/
- - SRCTAR=(${PKGNAME}-*.tar.gz)
- - SRC_BASENAME="${SRCTAR/%.tar.gz}"
- - tar -xvf "./$SRC_BASENAME.tar.gz"
- - cd "$SRC_BASENAME/"
-## from here on, CWD is inside the extracted source-tarball
- - rm -fv cabal.project.local
- # this builds all libraries and executables (without tests/benchmarks)
- - rm -f cabal.project.freeze
- - cabal new-build -w ${HC} --disable-tests --disable-benchmarks --allow-newer --constraint 'setup.Cabal installed' all
- # this builds all libraries and executables (including tests/benchmarks)
- # - rm -rf ./dist-newstyle
-
- # build & run tests
- - cabal new-build -w ${HC} ${TEST} ${BENCH} --allow-newer --constraint 'setup.Cabal installed' all
- - if [ "x$TEST" = "x--enable-tests" ]; then cabal new-test -w ${HC} ${TEST} --allow-newer --constraint 'setup.Cabal installed' all; fi
+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
+ # Packaging...
+ - ${CABAL} v2-sdist all | color_cabal_output
+ # Unpacking...
+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
+ - cd ${DISTDIR} || false
+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;
+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;
+ # Generate cabal.project
+ - rm -rf cabal.project cabal.project.local cabal.project.freeze
+ - touch cabal.project
+ - |
+ echo "packages: ./haddock-*" >> cabal.project
+ - |
+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(haddock)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+ - cat cabal.project || true
+ - cat cabal.project.local || true
+ # Building...
+ # this builds all libraries and executables (without tests/benchmarks)
+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all | color_cabal_output
+ # Building with tests and benchmarks...
+ # build & run tests, build benchmarks
+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output
+ # Testing...
+ - ${CABAL} v2-test $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output
+ # Building without installed constraints for packages in global-db...
+ - rm -f cabal.project.local
+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all | color_cabal_output
+# REGENDATA ["haddock.cabal","--output",".travis.yml"]
# EOF
diff --git a/haddock-api/haddock-api.cabal b/haddock-api/haddock-api.cabal
index 9a120f5d58..f8558dcada 100644
--- a/haddock-api/haddock-api.cabal
+++ b/haddock-api/haddock-api.cabal
@@ -166,11 +166,11 @@ test-suite spec
Haddock.Backends.Hyperlinker.Types
build-depends: ghc ^>= 8.8
- , ghc-paths ^>= 0.1.0.9
+ , ghc-paths ^>= 0.1.0.12
, haddock-library ^>= 1.8.0
, xhtml ^>= 3000.2.2
- , hspec >= 2.4.4 && < 2.7
- , QuickCheck >= 2.11 && < 2.13
+ , hspec >= 2.4.4 && < 2.8
+ , QuickCheck >= 2.11 && < 2.14
-- Versions for the dependencies below are transitively pinned by
-- the non-reinstallable `ghc` package and hence need no version
@@ -186,7 +186,7 @@ test-suite spec
, transformers
build-tool-depends:
- hspec-discover:hspec-discover >= 2.4.4 && < 2.7
+ hspec-discover:hspec-discover >= 2.4.4 && < 2.8
source-repository head
type: git
diff --git a/haddock-library/haddock-library.cabal b/haddock-library/haddock-library.cabal
index 9977347559..fe6aeedee5 100644
--- a/haddock-library/haddock-library.cabal
+++ b/haddock-library/haddock-library.cabal
@@ -19,6 +19,8 @@ bug-reports: https://github.com/haskell/haddock/issues
category: Documentation
extra-source-files:
CHANGES.md
+ fixtures/examples/*.input
+ fixtures/examples/*.parsed
common lib-defaults
default-language: Haskell2010
@@ -74,8 +76,8 @@ test-suite spec
Documentation.Haddock.Parser.Identifier
build-depends:
- , base-compat ^>= 0.9.3 || ^>= 0.10.0
- , QuickCheck ^>= 2.11 || ^>= 2.12
+ , base-compat ^>= 0.9.3 || ^>= 0.11.0
+ , QuickCheck ^>= 2.11 || ^>= 2.13.2
, deepseq ^>= 1.3.0.0 || ^>= 1.4.0.0
-- NB: build-depends & build-tool-depends have independent
@@ -83,10 +85,10 @@ test-suite spec
-- version of `hspec` & `hspec-discover` to ensure
-- intercompatibility
build-depends:
- , hspec >= 2.4.4 && < 2.7
+ , hspec >= 2.4.4 && < 2.8
build-tool-depends:
- , hspec-discover:hspec-discover >= 2.4.4 && < 2.7
+ , hspec-discover:hspec-discover >= 2.4.4 && < 2.8
test-suite fixtures
type: exitcode-stdio-1.0
@@ -101,11 +103,11 @@ test-suite fixtures
, base
-- extra dependencies
- , base-compat >= 0.9.3 && < 0.11
+ , base-compat ^>= 0.9.3 || ^>= 0.11.0
, directory ^>= 1.3.0.2
, filepath ^>= 1.4.1.2
- , optparse-applicative ^>= 0.14.0.0
- , tree-diff ^>= 0.0.0.1
+ , optparse-applicative ^>= 0.15
+ , tree-diff ^>= 0.1
source-repository head
type: git
diff --git a/haddock.cabal b/haddock.cabal
index 563955b914..0173fd843f 100644
--- a/haddock.cabal
+++ b/haddock.cabal
@@ -1,4 +1,4 @@
-cabal-version: 2.0
+cabal-version: 2.4
name: haddock
version: 2.23.0
synopsis: A documentation-generation tool for Haskell libraries
@@ -24,7 +24,7 @@ description:
from your source code.
.
<<https://cdn.rawgit.com/haskell/haddock/ghc-8.8/doc/cheatsheet/haddocks.svg>>
-license: BSD3
+license: BSD-3-Clause
license-file: LICENSE
author: Simon Marlow, David Waern
maintainer: Alec Theriault <alec.theriault@gmail.com>, Alex Biehl <alexbiehl@gmail.com>, Simon Hengel <sol@typeful.net>, Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
@@ -47,9 +47,10 @@ extra-source-files:
html-test/ref/*.html
hypsrc-test/src/*.hs
hypsrc-test/ref/src/*.html
- latex-test/src/Simple/*.hs
- latex-test/ref/Simple/*.tex
- latex-test/ref/Simple/*.sty
+ latex-test/src/**/*.hs
+ latex-test/ref/**/*.tex
+ hoogle-test/src/**/*.hs
+ hoogle-test/ref/**/*.txt
flag in-ghc-tree
description: Are we in a GHC tree?
@@ -62,7 +63,7 @@ executable haddock
hs-source-dirs: driver
ghc-options: -funbox-strict-fields -Wall -fwarn-tabs -O2 -threaded
- -- haddock typically only supports a single GHC major version
+ -- haddock typically only supports a single GHC major version
build-depends:
base ^>= 4.13.0.0
--
GitLab