[PATCH 3/3] ci: Add notes for integration jobs

Andrea Bolognani posted 3 patches 1 year ago
[PATCH 3/3] ci: Add notes for integration jobs
Posted by Andrea Bolognani 1 year ago
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>
---
 ci/integration.yml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/ci/integration.yml b/ci/integration.yml
index ff1bb5d81d..fec9ef9256 100644
--- a/ci/integration.yml
+++ b/ci/integration.yml
@@ -1,6 +1,10 @@
 include:
   - 'ci/integration-template.yml'
 
+# XXX 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
 
 
+# XXX 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
 
 
+# XXX 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
 
 
+# XXX 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
 
 
+# XXX 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
-- 
2.43.0
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org
Re: [PATCH 3/3] ci: Add notes for integration jobs
Posted by Peter Krempa 1 year ago
On Mon, Jan 08, 2024 at 11:43:24 +0100, Andrea Bolognani wrote:
> 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>
> ---
>  ci/integration.yml | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/ci/integration.yml b/ci/integration.yml
> index ff1bb5d81d..fec9ef9256 100644
> --- a/ci/integration.yml
> +++ b/ci/integration.yml
> @@ -1,6 +1,10 @@
>  include:
>    - 'ci/integration-template.yml'
>  
> +# XXX The integration tests use artifacts produced by the libvirt-perl

XXX? Either use 'Important:' 'Note:' or nothing altogether.

With that:

Reviewed-by: Peter Krempa <pkrempa@redhat.com>
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org
Re: Re: [PATCH 3/3] ci: Add notes for integration jobs
Posted by Andrea Bolognani 1 year ago
On Mon, Jan 08, 2024 at 11:54:00AM +0100, Peter Krempa wrote:
> On Mon, Jan 08, 2024 at 11:43:24 +0100, Andrea Bolognani wrote:
> > 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>
> > ---
> >  ci/integration.yml | 20 ++++++++++++++++++++
> >  1 file changed, 20 insertions(+)
> >
> > diff --git a/ci/integration.yml b/ci/integration.yml
> > index ff1bb5d81d..fec9ef9256 100644
> > --- a/ci/integration.yml
> > +++ b/ci/integration.yml
> > @@ -1,6 +1,10 @@
> >  include:
> >    - 'ci/integration-template.yml'
> >
> > +# XXX The integration tests use artifacts produced by the libvirt-perl
>
> XXX? Either use 'Important:' 'Note:' or nothing altogether.

That gets automatically highlighted by vim, which helps make it stand
out. 'NOTE' gets the same effect though. Would that work for you?

-- 
Andrea Bolognani / Red Hat / Virtualization
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org
Re: Re: [PATCH 3/3] ci: Add notes for integration jobs
Posted by Daniel P. Berrangé 1 year ago
On Mon, Jan 08, 2024 at 02:57:40AM -0800, Andrea Bolognani wrote:
> On Mon, Jan 08, 2024 at 11:54:00AM +0100, Peter Krempa wrote:
> > On Mon, Jan 08, 2024 at 11:43:24 +0100, Andrea Bolognani wrote:
> > > 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>
> > > ---
> > >  ci/integration.yml | 20 ++++++++++++++++++++
> > >  1 file changed, 20 insertions(+)
> > >
> > > diff --git a/ci/integration.yml b/ci/integration.yml
> > > index ff1bb5d81d..fec9ef9256 100644
> > > --- a/ci/integration.yml
> > > +++ b/ci/integration.yml
> > > @@ -1,6 +1,10 @@
> > >  include:
> > >    - 'ci/integration-template.yml'
> > >
> > > +# XXX The integration tests use artifacts produced by the libvirt-perl
> >
> > XXX? Either use 'Important:' 'Note:' or nothing altogether.
> 
> That gets automatically highlighted by vim, which helps make it stand
> out. 'NOTE' gets the same effect though. Would that work for you?

"NOTE" is more appropriate, because IMHO "XXX" indicates something that
is /already/ broken.

With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org
Re: Re: Re: [PATCH 3/3] ci: Add notes for integration jobs
Posted by Andrea Bolognani 1 year ago
On Mon, Jan 08, 2024 at 12:07:16PM +0000, Daniel P. Berrangé wrote:
> On Mon, Jan 08, 2024 at 02:57:40AM -0800, Andrea Bolognani wrote:
> > On Mon, Jan 08, 2024 at 11:54:00AM +0100, Peter Krempa wrote:
> > > On Mon, Jan 08, 2024 at 11:43:24 +0100, Andrea Bolognani wrote:
> > > > +++ b/ci/integration.yml
> > > > @@ -1,6 +1,10 @@
> > > >  include:
> > > >    - 'ci/integration-template.yml'
> > > >
> > > > +# XXX The integration tests use artifacts produced by the libvirt-perl
> > >
> > > XXX? Either use 'Important:' 'Note:' or nothing altogether.
> >
> > That gets automatically highlighted by vim, which helps make it stand
> > out. 'NOTE' gets the same effect though. Would that work for you?
>
> "NOTE" is more appropriate, because IMHO "XXX" indicates something that
> is /already/ broken.

That'd be "FIXME" IMO, I see "XXX" as a generic "you attention needed
here" marker. But the interpretation is not entirely clear-cut, and
I'm perfectly happy with using "NOTE" :)

Can I get ACKs for the rest of the series too, please?

-- 
Andrea Bolognani / Red Hat / Virtualization
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org