From 3ebcaef1273eeece1ddf6a73417923540b1e653f Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Tue, 23 Feb 2021 17:25:29 -0500 Subject: [PATCH] README: update with instructions on running tests --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index cbc50650..6139edad 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,15 @@ conflicts with services that might be running on your host, hydra and postgress Note that this is only ever meant as an ad-hoc way of executing Hydra during development. Please make use of the NixOS module for actually running Hydra in production. +### Running Tests + +After making your changes, verify the test suite still passes. After following the steps in [Development Environment](#development-environment), run: + +``` +$ nix-shell +$ make check +``` + ### JSON API You can also interface with Hydra through a JSON API. The API is defined in [hydra-api.yaml](./hydra-api.yaml) and you can test and explore via the [swagger editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/NixOS/hydra/master/hydra-api.yaml)