github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-27 11:31:05 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add general tests documentation in main README

Browse Source 
This PR adds the general tests documentation in main README of the
kata containers repository.

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
This commit is contained in:
Gabriela Cervantes 2024-03-04 16:51:17 +00:00
parent d5fa2bebd5
commit 5d50262422
2 changed files with 9 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -148,6 +148,10 @@ The table below lists the remaining parts of the project:
Kata Containers is now Kata Containers is now
[available natively for most distributions](docs/install/README.md#packaged-installation-methods). [available natively for most distributions](docs/install/README.md#packaged-installation-methods).
## General tests
See the [tests documentation](tests/README.md).
## Metrics tests ## Metrics tests
See the [metrics documentation](tests/metrics/README.md). See the [metrics documentation](tests/metrics/README.md).

39
tests/README.md
View File

@ -10,44 +10,15 @@ and with different container managers.
1. Integration tests to ensure compatibility with: 1. Integration tests to ensure compatibility with:
- [Kubernetes](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/kubernetes) - [Kubernetes](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/kubernetes)
- [Cri-Containerd](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/cri-containerd) - [`Cri-Containerd`](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/cri-containerd)
- [Docker](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/docker) - [Docker](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/docker)
- [Nerdctl](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/nerdctl) - [`Nerdctl`](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/nerdctl)
- [Nydus](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/nydus) - [`Nydus`](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/nydus)
- [Runk](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/runk) - [`Runk`](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/runk)
2. [Stability tests](https://github.com/kata-containers/kata-containers/tree/main/tests/stability) 2. [Stability tests](https://github.com/kata-containers/kata-containers/tree/main/tests/stability)
3. [Metrics](https://github.com/kata-containers/kata-containers/tree/main/tests/metrics) 3. [Metrics](https://github.com/kata-containers/kata-containers/tree/main/tests/metrics)
4. [Functional](https://github.com/kata-containers/kata-containers/tree/main/tests/functional) 4. [Functional](https://github.com/kata-containers/kata-containers/tree/main/tests/functional)
## GitHub Actions ## GitHub Actions
Kata Containers uses GitHub Actions in the [Kata Containers](https://github.com/kata-containers/kata-containers) repository. Kata Containers uses GitHub Actions in the [Kata Containers](https://github.com/kata-containers/kata-containers/tree/main/.github/workflows) repository.
## Breaking Compatibility
In case the patch you submit breaks the CI because it needs to be tested
together with a patch from another `kata-containers` repository, you have to
specify which repository and which pull request it depends on.
Using a simple tag `Depends-on:` in your commit message will allow the CI to
run properly. Notice that this tag is parsed from the latest commit of the
pull request.
For example:
```
Subsystem: Change summary
Detailed explanation of your changes.
Fixes: #nnn
Depends-on:github.com/kata-containers/kata-containers#999
Signed-off-by: <contributor@foo.com>
```
In this example, we tell the CI to fetch the pull request 999 from the `kata-containers`
repository and use that rather than the `main` branch when testing the changes
contained in this pull request.