README.md update

[?]
May 15, 2020, 11:59 AM
43CQEJTEQTKAA2WATBOZPD3PT35ZT76NBCRS2N6VIRY5KP467OTAC

Dependencies

Change contents

  • edit in README.md at line 87
    [2.6][2.6:352]()
    ### Development Workflow
    When working on new features or bug fixes you want to be able to run Hydra from your working copy. There are
    two ways to do this. One is better for interactive development and provides faster feedback cycles, the other
    is more convenient for a single test run of Hydra from the working copy (suiteable for PR reviews).
  • replacement in README.md at line 88
    [2.353][2.353:373]()
    #### Using runHydra
    [2.353]
    [2.373]
    ### Executing Hydra During Development
  • replacement in README.md at line 90
    [2.374][2.374:434]()
    Hydra can be built and executed using the `runHydra` shell:
    [2.374]
    [2.434]
    When working on new features or bug fixes you need to be able to run Hydra from your working copy. This
    can be done using [foreman](https://github.com/ddollar/foreman):
  • replacement in README.md at line 94
    [2.439][2.439:475]()
    $ nix-shell default.nix -A runHydra
    [2.439]
    [3.2030]
    $ nix-shell
    $ # hack hack
    $ make
    $ foreman start
  • replacement in README.md at line 100
    [3.272][2.476:765]()
    This will spawn a shell that starts hydra-server, hydra-queue-runner, hydra-evaluator and postgres using [foreman](https://github.com/ddollar/foreman).
    In order to not collide with potentially existing installations running on default ports hydra and postgres are running on custom ports:
    [3.272]
    [2.765]
    Have a look at the [Procfile](./Procfile) if you want to see how the processes are being started. In order to avoid
    conflicts with services that might be running on your host, hydra and postgress are started on custom ports:
  • replacement in README.md at line 106
    [2.809][2.809:977]()
    **Note**: In some cases you may want to skip test execution. You can do so by passing `doCheck false`:
    ```
    $ nix-shell default.nix -A runHydra --arg doCheck false
    ```
    [2.809]
    [2.977]
    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.
  • edit in README.md at line 109
    [2.978][2.978:1273]()
    #### Using foreman
    When you are actively working on the code, you need fast feedback cycles and thus want incremental builds. Instead of using
    `runHydra` you can just run `foreman start` directly in the normal `nix-shell` environment:
    ```
    $ nix-shell
    $ # hack hack
    $ make
    $ foreman start
    ```