Skip to content

Commit

Permalink
Point out validate.sh in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
9999years authored and Mikolaj committed Sep 28, 2024
1 parent 2c92113 commit 1d57a33
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ $ cabal build cabal-tests # etc...
## Running tests

There are two ways to run tests: in CI with GitHub actions and locally with
`./validate.sh`.

### Using GitHub Actions.

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

### Running tests locally.

The [`./validate.sh`](./validate.sh) script runs all the test suites. It takes
various options to restrict the test suites it runs; use `--help` to list them.

To run tests locally with `cabal`, you will need to know the
name of the test suite you want. Cabal and cabal-install have
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)
Expand Down

0 comments on commit 1d57a33

Please sign in to comment.