[at-spi2-core: 1/7] .gitlab-ci/README.md - basic documentation on the CI scripts

[Federico Mena Quintero <federico src gnome org>]

commit fe37ef337db152c9b67db31db1c5ce1a1f847225
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Dec 14 16:53:00 2021 -0600

    .gitlab-ci/README.md - basic documentation on the CI scripts

 .gitlab-ci/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
---
diff --git a/.gitlab-ci/README.md b/.gitlab-ci/README.md
new file mode 100644
index 00000000..f80669b5
--- /dev/null
+++ b/.gitlab-ci/README.md
@@ -0,0 +1,26 @@
+# Continuous Integration scripts for at-spi2-core
+
+Please see the general [documentation for at-spi2-core's Gitlab CI][ci-docs].
+
+This directory contains scripts which get called during a CI run, and
+utilities to maintain the CI infrastructure.
+
+* `run-tests.sh` - Runs the test suite and prints other diagnostics.
+
+* `gen-coverage.sh` - After the test suite is run, merges the various
+  code coverage reports from `lcov`, and generates an HTML report.
+  
+* `lcovrc` - Configuration file for `lcov`, used by `gen-coverage.sh`.
+  Among other things, this tells `lcov` to exclude branch coverage for
+  the unreachable branches of `g_return_if_fail()` and friends.
+  
+* `run-style-check.sh` - Runs `clang-format-diff` to test for source
+  files with inconsistent formatting, and uploads the resulting report
+  to gitlab so it can be viewed as part of a merge request's analysis.
+  
+* `search-common-ancestor.sh` - Utility used from
+  `run-style-check.sh`; finds a git branch point from the current
+  commit.
+  
+
+[ci-docs]: ../devel-docs/gitlab-ci.md