When submitting patches to xen-devel, add a link to a successful pipeline run.
Signed-off-by: Stefano Stabellini <stefano.stabell...@amd.com> --- Changes in v2: - address Julien's comments diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc index 1991932b68..13bb3bf47a 100644 --- a/docs/process/sending-patches.pandoc +++ b/docs/process/sending-patches.pandoc @@ -314,3 +314,38 @@ 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. + +When submitting a patch or patch series, please include a link to the +successful GitLab pipeline run on your personal branch. The branch +should be based on a recent version of the "master" branch, ideally not +older than two days. + +This information can be added after the `---` line. For example: + + --- + Test CI pipeline: + https://gitlab.com/xen-project/people/your-username/xen/-/pipelines/1980129839 + +While it is technically possible to implement an automated system that +picks up patches and patch series from xen-devel and runs the GitLab +pipeline on them automatically, doing so would consume a significant +amount of resources on the testing infrastructure. There is no reliable +way to automatically determine whether a patch is close to being +committed or still undergoing substantial review. By having users submit +the link to the pipeline manually, we can manage testing resources much +more efficiently. + +When submitting new features, please also consider whether you can add a +GitLab test for the feature to ensure it continues to work correctly in +the future.
