Re: [PATCH] docs/sending-patches: add GitLab pipeline link

[Stefano Stabellini <sstabellini@xxxxxxxxxx>]

On Mon, 18 Aug 2025, Julien Grall wrote:
> Hi Stefano,
> 
> On 15/08/2025 21:12, Stefano Stabellini wrote:
> > When submitting patches to xen-devel, add a link to a successful
> > pipeline run.
> 
> Does this mean we have enough capacity to handle normal CI job + submission?

Yes, it should be OK, especially given that most regular contributors
already run CI jobs before submitting.


> Also, as we try to encourage people to use the gitlab CI. So we would probably
> also encourage them to write new tests because in a lot of cases we will add
> new code. So the pipeline is only going to confirm that we are regressing
> existing tests (which may be irrelevant to the subsystem modified).

Good point


> > Signed-off-by: Stefano Stabellini <stefano.stabellini@xxxxxxx>
> > 
> > diff --git a/docs/process/sending-patches.pandoc
> > b/docs/process/sending-patches.pandoc
> > index 1991932b68..6e1401ea22 100644
> > --- a/docs/process/sending-patches.pandoc
> > +++ b/docs/process/sending-patches.pandoc
> > @@ -314,3 +314,23 @@ A patch should always be sent **to** the xen-devel
> > mailing list
> >   of all touched code areas should get a copy of the mail via **Cc**. In
> > case
> >   some other recipients are known to be interested in the patch, they can be
> >   added via **Cc**, too.
> > +
> > +## Testing
> > +
> > +Xen Project uses a GitLab-based CI infrastructure. You can request to
> > +have your GitLab account added to the Xen Project organization on GitLab
> > +(https://gitlab.com/xen-project) by reaching out to THE REST maintainers
> > +via xen-devel or Matrix. Once your account is added to the Xen Project
> > +organization on GitLab, also a personal Xen repository will be created
> > +for you under https://gitlab.com/xen-project/people/<your-username>/xen.
> > +You will be able to trigger a GitLab testing pipeline with a single git
> > +push to your personal Xen repository.
> 
> I think it would be worth mentioning that this should be based on a recent
> "master" (I would say less than two days old).

Good idea


> Also, can you clarify why we are asking the user to trigger the pipeline
> rather than having a both that will pick a series and test it?

I'll add an explanation


> > +
> > +When submitting a non-trivial patch or a non-trivial patch series,
> 
> This wording is ambiguous. But even trivial patch could result to regression.
> So I am not sure why we would want to exclude them. Can you clarify?

I'll take it out.


> > +please include a link to the successful GitLab pipeline run on your
> > +personal branch. This information can be added after the `---` line.
> >> +For example:
> > +
> > +    ---
> > +    Test CI pipeline:
> > +
> > https://gitlab.com/xen-project/people/your-username/xen/-/pipelines/1980129839
> 
> Cheers,
> 
> -- 
> Julien Grall
>