From 9f048854f28ead26b2aef1115758c6e5ac9bad1f Mon Sep 17 00:00:00 2001
From: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
Date: Tue, 25 May 2021 13:06:57 -0500
Subject: [PATCH] docs: Update README to include Jenkins and github actions
 documentation

This PR updates the README to start including more information about
Jenkins jobs and github actions that are being used in kata repositories.

Fixes #3565

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
---
 README.md                        | 16 ++++++++++++++++
 cmd/check-spelling/data/main.txt |  2 ++
 2 files changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 7145da510..ddfedb480 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@
     * [CI Content](#ci-content)
         * [Centralised scripts](#centralised-scripts)
         * [CI setup](#ci-setup)
+        * [Controlling the CI](#controlling-the-ci)
         * [Detecting a CI system](#detecting-a-ci-system)
         * [Breaking Compatibility](#breaking-compatibility)
     * [CLI tools](#cli-tools)
@@ -77,6 +78,21 @@ Use `make list-install-targets` to retrieve all the available install targets.
 > CI. Some of this setup runs as the `root` user and **could break your developer's
 > system**. See [Developer Mode](#developer-mode).
 
+### Controlling the CI
+
+#### GitHub Actions
+
+Kata Containers uses GitHub Actions in the [Kata Containers](https://github.com/kata-containers/kata-containers) repos.
+All those actions, apart from the one to test `kata-deploy`, are automatically triggered when
+a pull request is submitted. The trigger phrase for testing kata-deploy is `/test_kata_deploy`.
+
+#### Jenkins
+
+The Jenkins configuration and most documentation is kept in the [CI repository](https://github.com/kata-containers/ci).
+Jenkins is setup to trigger a CI run on all the slaves/nodes when a `/test` comment is added to a pull request. However,
+there are some specific comments that are defined for specific CI slaves/nodes which are defined in the Jenkins
+`config.xml` files in the `<triggerPhase>` XML element in the [CI repository](https://github.com/kata-containers/ci).
+
 ### Detecting a CI system
 
 The strategy to check if the tests are running under a CI system is to see
diff --git a/cmd/check-spelling/data/main.txt b/cmd/check-spelling/data/main.txt
index 17ed5ef5d..b07207288 100644
--- a/cmd/check-spelling/data/main.txt
+++ b/cmd/check-spelling/data/main.txt
@@ -22,6 +22,7 @@ crypto		# Cryptography
 DaemonSet/AB
 deliverable/AB
 devicemapper/B
+deploy
 dialer
 dialog/A
 distro/AB
@@ -45,6 +46,7 @@ implementor/A
 iodepth/A
 ioengine/A
 iptables
+kata
 Kat/AB		# "Kat Herding Team" :)
 keypair/A
 lifecycle/A