ci: Add notes for integration jobs

These are special in that, when a new target is introduced, some
preparation is needed before the changes can be merged. Since
this only happens every six months or so, it's unsurprising that
we keep messing it up and forgetting some steps. Having notes
right in the file will hopefully help going forward.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>

diff --git a/ci/integration.yml b/ci/integration.yml
index ff1bb5d81dc0405a2a025fc84557ed1b1470e53b..1614aa56d6a96674a18fd5ce5e0f27ab84260e9e 100644 (file)
--- a/ci/integration.yml
+++ b/ci/integration.yml
@@ -1,6 +1,10 @@
 include:
   - 'ci/integration-template.yml'
 
+# NOTE The integration tests use artifacts produced by the libvirt-perl
+# and libvirt-python CI jobs, so the new target needs to be introduced
+# there before it can be used here. The VM template for the target
+# also needs to be created on the runner host.
 .centos-stream-8-tests:
   variables:
     # needed by libvirt-gitlab-executor
@@ -41,6 +45,10 @@ centos-stream-8-tests-local-env:
       artifacts: true
 
 
+# NOTE The integration tests use artifacts produced by the libvirt-perl
+# and libvirt-python CI jobs, so the new target needs to be introduced
+# there before it can be used here. The VM template for the target
+# also needs to be created on the runner host.
 .centos-stream-9-tests:
   variables:
     # needed by libvirt-gitlab-executor
@@ -81,6 +89,10 @@ centos-stream-9-tests-local-env:
       artifacts: true
 
 
+# NOTE The integration tests use artifacts produced by the libvirt-perl
+# and libvirt-python CI jobs, so the new target needs to be introduced
+# there before it can be used here. The VM template for the target
+# also needs to be created on the runner host.
 .fedora-38-tests:
   variables:
     # needed by libvirt-gitlab-executor
@@ -121,6 +133,10 @@ fedora-38-tests-local-env:
       artifacts: true
 
 
+# NOTE The integration tests use artifacts produced by the libvirt-perl
+# and libvirt-python CI jobs, so the new target needs to be introduced
+# there before it can be used here. The VM template for the target
+# also needs to be created on the runner host.
 .fedora-39-tests:
   variables:
     # needed by libvirt-gitlab-executor
@@ -161,6 +177,10 @@ fedora-39-tests-local-env:
       artifacts: true
 
 
+# NOTE The integration tests use artifacts produced by the libvirt-perl
+# and libvirt-python CI jobs, so the new target needs to be introduced
+# there before it can be used here. The VM template for the target
+# also needs to be created on the runner host.
 .fedora-39-upstream-qemu-tests:
   variables:
     # needed by libvirt-gitlab-executor