From 5d502624220102d624639eec80989ff47c826ab5 Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Mon, 4 Mar 2024 16:51:17 +0000 Subject: [PATCH] docs: Add general tests documentation in main README This PR adds the general tests documentation in main README of the kata containers repository. Signed-off-by: Gabriela Cervantes --- README.md | 4 ++++ tests/README.md | 39 +++++---------------------------------- 2 files changed, 9 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 118a466a7..aef206035 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,10 @@ The table below lists the remaining parts of the project: Kata Containers is now [available natively for most distributions](docs/install/README.md#packaged-installation-methods). +## General tests + +See the [tests documentation](tests/README.md). + ## Metrics tests See the [metrics documentation](tests/metrics/README.md). diff --git a/tests/README.md b/tests/README.md index 7fbe20b85..0d2f1b760 100644 --- a/tests/README.md +++ b/tests/README.md @@ -10,44 +10,15 @@ and with different container managers. 1. Integration tests to ensure compatibility with: - [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) - - [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) - - [Runk](https://github.com/kata-containers/kata-containers/tree/main/tests/integration/runk) + - [`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) + - [`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) 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) ## GitHub Actions -Kata Containers uses GitHub Actions in the [Kata Containers](https://github.com/kata-containers/kata-containers) 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: - -``` - -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. +Kata Containers uses GitHub Actions in the [Kata Containers](https://github.com/kata-containers/kata-containers/tree/main/.github/workflows) repository.