summaryrefslogtreecommitdiffstats
path: root/test/ci/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/ci/README.md')
-rw-r--r--test/ci/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/test/ci/README.md b/test/ci/README.md
new file mode 100644
index 000000000..fe80d7c04
--- /dev/null
+++ b/test/ci/README.md
@@ -0,0 +1,14 @@
+This directory contains scripts and other files that are executed by our
+CI integration tests.
+
+CI should call a script. The only arguments that each script should accept
+are:
+
+1) Path to openshift-ansible/playbooks
+2) Inventory path.
+3) Extra vars path.
+
+Ideally, inventory path and extra vars should live somewhere in this
+subdirectory instead of the CI's source.
+
+Extravars should typically be unnecessary.