mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-22 06:10:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add description for containerized-test to development-guide

Browse Source 
Suggested-by: Wilmar den Ouden <info@wilmardenouden.nl>
Signed-off-by: Niels de Vos <ndevos@redhat.com>
This commit is contained in:
Niels de Vos 2020-04-21 15:41:17 +02:00 committed by mergify[bot]
parent 22c0baa4b0
commit 718e76d290
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/development-guide.md
View File

@ -44,6 +44,26 @@ To build ceph-csi in a container:
The built binary will be present under `_output/` directory.
### Running Ceph-CSI tests in a container
Once the changes to the sources compile, it is good practise to run the tests
that validate the style and other basics of the source code. Execute the unit
tests (in the `*_test.go` files) and check the formatting of YAML files,
MarkDown documents and shell scripts:
`$ make containerized-test`
It is also possible to run only selected tests, these are the targets in the
`Makefile` in the root of the project. For example, run the different static
checks with:
`$ make containerized-test TARGET=static-check`
In addition to running tests locally, each Pull Request that is created will
trigger Continous Integration tests that include the `containerized-test`, but
also additional functionality tests that are defined under the `e2e/`
directory.
### Code contribution workflow
ceph-csi repository currently follows GitHub's