github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-31 16:36:38 +00:00
Code Issues Projects Releases Wiki Activity

docs: add note about virtcontainers if testing runtime

Browse Source 
If following the contributing doc and wanting to run make check and
make test in kata-runtime, the virtcontainers/bin/hook executable
is expected to exist. But it only exists if it is compiled and
installed. So a note has been added that if make test|check for
runtime, to ensure that virtcontainers has been compiled and
installed.

Signed-off-by: ccollicutt <curtis@serverascode.com>
This commit is contained in:
curtis
2019-01-15 03:04:48 -05:00
committed by ccollicutt
parent 926772feb5
commit d4ce3e454f
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -73,8 +73,17 @@ Kata Containers utilizes a number of [CI systems](https://en.wikipedia.org/wiki/
to automatically check every PR. As well as performing execution tests locally on
your PR before submission, you are strongly encouraged to also run the same suite of
[static checks](https://github.com/kata-containers/tests/blob/master/.ci/static-checks.sh)
the CI will execute. The easiest way to execute these in most of the repositories is
to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled:
the CI will execute.
> **Note:** If working on `kata-runtime`, first ensure `make` and `make install` has been run in the virtcontainers subdirectory. (See [virtcontainers](https://github.com/kata-containers/runtime/blob/master/virtcontainers/documentation/Developers.md#testing) documentation for more information.)
>
> ```sh
> $ cd runtime/virtcontainers
> $ make
> $ sudo -E PATH=$PATH make install
> ```
The easiest way to execute static checks in most of the repositories is to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled.
```sh
$ export KATA_DEV_MODE=true