ahuston-0/hydra
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Start checking PRs with perlcritic

Browse Source
This commit is contained in:
Your Name
2021-08-19 16:13:45 -04:00
parent 098e48d055
commit 241985fb2d
4 changed files with 38 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -106,17 +106,33 @@ 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
### Checking your patches
After making your changes, verify the test suite still passes. After following the steps in [Development Environment](#development-environment), run:
After making your changes, verify the test suite passes and perlcritic is still happy.
Start by following the steps in [Development Environment](#development-environment).
Then, you can run the tests and the perlcritic linter together with:
```console
$ nix-shell
$ make check
```
You can run a single test with:
```
$ nix-shell
$ make check
$ # Or, to run a single test, use:
$ yath test ./t/foo/bar.t
```
And you can run just perlcritic with:
```
$ nix-shell
$ make perlcritic
```
### 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)