]> git.ipfire.org Git - thirdparty/shadow.git/commitdiff
doc: add Continuous Integration
authorIker Pedrosa <ipedrosa@redhat.com>
Tue, 14 Mar 2023 15:43:23 +0000 (16:43 +0100)
committerSerge Hallyn <serge@hallyn.com>
Mon, 3 Apr 2023 15:42:22 +0000 (10:42 -0500)
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
doc/contributions/ci.md [new file with mode: 0644]

diff --git a/doc/contributions/ci.md b/doc/contributions/ci.md
new file mode 100644 (file)
index 0000000..37e45d6
--- /dev/null
@@ -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.