Skip to content

Commit 6c2b6c3

Browse files
committed
Point out validate.sh in CONTRIBUTING.md
1 parent fd8b092 commit 6c2b6c3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ $ cabal build cabal-tests # etc...
5959
6060
## Running tests
6161

62+
There are two ways to run tests: in CI with GitHub actions and locally with
63+
`./validate.sh`.
64+
6265
### Using GitHub Actions.
6366

6467
If you are not in a hurry, the most convenient way to run tests on Cabal
@@ -115,6 +118,9 @@ or continuous integration breakage; please file a bug.
115118

116119
### Running tests locally.
117120

121+
The [`./validate.sh`](./validate.sh) script runs all the test suites. It takes
122+
various options to restrict the test suites it runs; use `--help` to list them.
123+
118124
To run tests locally with `cabal`, you will need to know the
119125
name of the test suite you want. Cabal and cabal-install have
120126
several. Also, you'll want to read [Where are my build products?](http://cabal.readthedocs.io/en/latest/nix-local-build.html#where-are-my-build-products)

0 commit comments

Comments
 (0)