From 46c301e7210b74e3ba75a0360fdacb23b6dd107e Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 24 Aug 2018 11:53:03 +0200 Subject: [PATCH] Document shared queue and policy for integrated-gate The integrated-gate queue should stay in project-config as a policy. Document this and briefly document shared queues in general. Change-Id: I71900ff7fc65795b6c4743a38d185308992ad6fa --- doc/source/creators.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/source/creators.rst b/doc/source/creators.rst index 1a26274..874d946 100644 --- a/doc/source/creators.rst +++ b/doc/source/creators.rst @@ -554,13 +554,32 @@ that Zuul v3 was specifically designed to push onto projects themselves. In an effort to take advantage of this functionality we now ask that projects manage the PTI job config in repo. +Shared Queues for Cross-Project Testing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When your projects are closely coupled together, you want to make sure +changes entering the gate are going to be tested with the version of +other projects currently enqueued in the gate (since they will +eventually be merged and might introduce breaking features). + +For such `cross-project testing +`_ +you need to put projects in a comon queue. The queue configuration for +the ``integrated`` queue needs to stay in the central config +repository since this is cross-teams. If only projects of your team +are coupled, you can place this in-repo as well:: + + - project: + gate: + queue: + .. _central-config-exceptions: Central Config Exceptions ~~~~~~~~~~~~~~~~~~~~~~~~~ There are several notable exceptions for job configs that should remain -in the central config repository: +in the central config repository ``openstack-infra/project-config``: * Translation jobs for all branches. * Jobs that should only run against the master branch of the project @@ -579,6 +598,9 @@ in the central config repository: ``puppet-release-jobs`` include jobs that are not "branch aware" since they are triggered by tag based events. +* The queue configuration for the ``integrated`` queue needs to stay + in the central config repository. + .. _add-to-governance-repo: Add New Repository to the Governance Repository