zuul/zuul
Code Issues Proposed changes

Correct image-build-name docs

Browse Source 
The correct name for this attribute is 'image-build-name' rather
than 'image-name'.

Change-Id: Ie6453445a5b60f256169cd4850bac55e14d36c39
This commit is contained in:
James E. Blair
2026-04-10 06:45:07 -07:00
parent 0b222b0557
commit 967bea69bc
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/build-nodes.rst
+8 -8
View File
@@ -162,14 +162,14 @@ missing image is:
- event: image-build
To tell Zuul a job is an image build job, use the
:attr:`job.image-name` attribute to indicate to Zuul that job is used
to build an image with that name. The name must match a :ref:`image`
object, and the job must be defined in the same repository as the
image object. The job is responsible for building the image and
uploading it to an object storage system. It must return information
about where the image is stored using :ref:`return_values`. Here is
an example `zuul_return` stanza showing the expected information for a
qcow2 image:
:attr:`job.image-build-name` attribute to indicate to Zuul that job is
used to build an image with that name. The name must match a
:ref:`image` object, and the job must be defined in the same
repository as the image object. The job is responsible for building
the image and uploading it to an object storage system. It must
return information about where the image is stored using
:ref:`return_values`. Here is an example `zuul_return` stanza showing
the expected information for a qcow2 image:
.. code-block:: yaml
doc/source/config/job.rst
+1 -1
View File
@@ -1615,7 +1615,7 @@ Here is an example of two job definitions:
This scheme will produce unique workspace paths for every repository
and won't cause collisions.
.. attr:: image-name
.. attr:: image-build-name
:type: str
If this is an image build job (see :ref:`image-creation`), set
doc/source/drivers/zuul.rst
+1 -1
View File
@@ -102,7 +102,7 @@ Reporter Configuration
If this value is set to `true`, then any jobs in the buildset
which are configured as image jobs (i.e., they have
:attr:`job.image-name` set) will have their image build
:attr:`job.image-build-name` set) will have their image build
artifacts stored in Zuul's image registry, and the zuul-launcher
will begin uploading those artifacts to providers.