Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

Commit

Permalink
Merge pull request #3566 from GabyCT/topic/addgithubactions
Browse files Browse the repository at this point in the history
docs: Update README to include Jenkins and github actions documentation
  • Loading branch information
Julio Montes authored May 26, 2021
2 parents 9591918 + 9f04885 commit 899576a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions cmd/check-spelling/data/main.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ crypto # Cryptography
DaemonSet/AB
deliverable/AB
devicemapper/B
deploy
dialer
dialog/A
distro/AB
Expand All @@ -45,6 +46,7 @@ implementor/A
iodepth/A
ioengine/A
iptables
kata
Kat/AB # "Kat Herding Team" :)
keypair/A
lifecycle/A
Expand Down

0 comments on commit 899576a

Please # to comment.