diff options
| author | Iker Pedrosa <ipedrosa@redhat.com> | 2023-03-14 16:43:23 +0100 |
|---|---|---|
| committer | Serge Hallyn <serge@hallyn.com> | 2023-04-03 10:42:22 -0500 |
| commit | 6ceddd92052f62cdbf680c34a54356e7be715071 (patch) | |
| tree | 8ac4a5de8200e818543822033ad685d73f6acf3e | |
| parent | 77c6cc98579a00bd4db829996286b928c8a07ea7 (diff) | |
doc: add Continuous Integration
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
| -rw-r--r-- | doc/contributions/ci.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/contributions/ci.md b/doc/contributions/ci.md new file mode 100644 index 00000000..37e45d6c --- /dev/null +++ b/doc/contributions/ci.md @@ -0,0 +1,25 @@ +# Continuous Integration (CI) + +Shadow runs a CI workflow every time a pull-request (PR) is updated. This +workflow contains several checks to assure the quality of the project, and +only pull-requests with green results are merged. + +## Build & install + +The project is built & installed on Ubuntu, Alpine, Debian and Fedora. The last +three distributions are built & installed on containers, and the workflow can +be triggered locally by following the instructions specified in the +[Build & install](build_install.md#containers) page. + +## System tests + +The project is tested on Ubuntu. For that purpose it is built & installed in +this distribution in a VM. You can run this step locally by following the +instructions provided in the [Tests](tests.md#system-tests) page. + +## Static code analysis + +C and shell static code analysis is also executed. For that purpose +[CodeQL](https://codeql.github.com/) and +[Differential ShellCheck](https://github.com/marketplace/actions/differential-shellcheck) +are used. |