opendev/infra-manual
Code Issues Proposed changes

zuul v3: Expand section on what *to* convert

Browse Source 
There was a little confusion about where various jobs should live. Add
the clarification received to the docs.

Change-Id: Ibe8dfe1ce3723dee8d682a7d3fa4cb57561614d9
This commit is contained in:
Stephen Finucane 2017-12-01 11:21:31 +00:00
parent bdb20e2b47
commit d2a49b7ee7
1 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/source/zuulv3.rst
View File

@ -866,20 +866,20 @@ If those don't apply, this will mean the following changes:
.. _what_not_to_convert: .. _what_not_to_convert:
What Not to Convert? What to Convert?
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
Note that some jobs should always stay in `project-config`_. We always Some jobs should not be migrated and should always stay in `project-config`_.
must have ``system-required`` in `project-config`_, since that's a system
thing.
Official OpenStack projects should implement the OpenStack wide jobs - We always must have ``system-required`` in `project-config`_, since that's a
mentioned in the `Project Testing Interface`_ (PTI) document. These jobs system thing.
should remain in `project-config`_ but all the other things (things
special to a given project) can happen in the project repository.
Translation jobs should also live in `project-config`_, since those - Official OpenStack projects should implement the OpenStack wide jobs
access the external translation site. mentioned in the `Project Testing Interface`_ (PTI) document. These jobs
should remain in `project-config`_.
- Translation jobs should also live in `project-config`_, since those access
the external translation site.
So, a non-complete list of templates that should not live in project's own So, a non-complete list of templates that should not live in project's own
configuration but stay in `project-config`_: configuration but stay in `project-config`_:
@ -893,6 +893,17 @@ configuration but stay in `project-config`_:
* release-notes-jobs (PTI) * release-notes-jobs (PTI)
* translation-jobs * translation-jobs
Outside of these jobs, most jobs can be migrated to a project repository. If a
job is used by a single project then migration is simple: you should move the
job to that project's repository. If a job is used by multiple projects then
things get a little trickier. In this scenario, you should move the job to the
project that is mostly testing and where the developers are best placed to
maintain the job. For example, a job that validates interaction between nova
and os-vif might be run for both of these projects. However, the job is mostly
focused on os-vif and it's likely that os-vif developers would be best placed
to resolve issues that may arise. As a result, the job should live in os-vif.
More information is provided below.
Where Should Jobs And Templates Live? Where Should Jobs And Templates Live?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~