From: Iker Pedrosa Date: Tue, 14 Mar 2023 15:43:23 +0000 (+0100) Subject: doc: add Continuous Integration X-Git-Tag: 4.14.0-rc1~110 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6ceddd92052f62cdbf680c34a54356e7be715071;p=thirdparty%2Fshadow.git doc: add Continuous Integration Signed-off-by: Iker Pedrosa --- diff --git a/doc/contributions/ci.md b/doc/contributions/ci.md new file mode 100644 index 000000000..37e45d6c9 --- /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.