docs/Developer/ci-tests.md · streamly

git.iko.soy/streamly

on 6e77cdb help sign in

54 lines 1.1 kB history raw

1# Continuous integration tests

3This file documents the required CI test matrix so that we do not accidentally

4remove or miss any tests when making changes to CI configs:

6## For prime GHC version:

8Distribution:

9 * build from source distribution WITHOUT a cabal.project file

11Performance:

12 * `--flag inspection` + `--flag fusion-plugin`

13 * Run `bin/bench.sh --quick --raw`

14 * Run `bin/test.sh`

15 * -Werror (for lib, test, bench)

17Lint:

18 * -Werror (for lib, test, bench) (Need a Werror with default flags)

19 * hlint

21Doctests:

22 * Run cabal-docspec

24Coverage:

25 * `coverage` build

27Debug:

28 * --flag debug

30StreamK:

31 * --flag streamk

33Windows:

34 * Windows + stack

36MacOS:

37 * MacOS + stack

39## Other GHC versions

41GHC head:

42 * `--flag inspection` + `--flag fusion-plugin` tests to catch any

43 issues early.

44 * Ideally we should also be running perf tests and compare

45 against the prime version.

47Other GHC versions:

48* build lib, test, bench, docs, run tests, on Linux platform, using

49 cabal build

51## GHCJS

53GHCJS:

54* Latest version ghcjs build (lib, test, bench), run tests