Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gardener-robot-ci-2 committed Dec 27, 2023
1 parent dbed5f5 commit 008cd01
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 8 deletions.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion traits/draft_release.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ <h1><em>draft_release</em> Trait<a class="headerlink" href="#draft-release-trait
<h2>Dependencies<a class="headerlink" href="#trait-draft-release" title="Link to this heading"></a></h2>
<p>This trait requires the following traits to be declared:</p>
<ul class="simple">
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
</ul>
</section>
<p>Declaring jobs will create or update draft-release-notes that will automatically be collected for
Expand Down
21 changes: 16 additions & 5 deletions traits/publish.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,8 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
<td><p>additional targets to publish built images to. Entries _may_ contain a tag (which is
honoured, if present). Entries without a tag will use the same tag as the “main” image
(defined by <code class="code docutils literal notranslate"><span class="pre">image</span></code> attribute).
only supported for docker or docker-buildx OCI-Builder.</p></td>
only supported for docker or docker-buildx OCI-Builder. Must not be used in
conjunction with <code class="code docutils literal notranslate"><span class="pre">targets</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p>inputs</p></td>
<td><p>no</p></td>
Expand Down Expand Up @@ -247,9 +248,19 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p>only for multistage builds: the target up to which to build</p></td>
<td><p>only for multistage builds: the target up to which to build.
must not be used if <code class="code docutils literal notranslate"><span class="pre">targets</span></code> is defined.</p></td>
</tr>
<tr class="row-even"><td><p>resource_labels</p></td>
<tr class="row-even"><td><p>targets</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>list</p></td>
<td><p>if set, the given targets are built in the given order in the same build environment.
This is useful to reduce resource consumption for multiple builds sharing common
prerequisite build steps.
Only supported if oci-builder is set to <code class="code docutils literal notranslate"><span class="pre">docker-buildx</span></code> or <code class="code docutils literal notranslate"><span class="pre">docker</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>resource_labels</p></td>
<td><p>no</p></td>
<td><p><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[]</span>
</pre></div>
Expand All @@ -258,7 +269,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
<td><p>List[Label]</p></td>
<td><p>labels to add to the resource declaration for this image in base-component-descriptor</p></td>
</tr>
<tr class="row-odd"><td><p>build_args</p></td>
<tr class="row-even"><td><p>build_args</p></td>
<td><p>no</p></td>
<td><p><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">{}</span>
</pre></div>
Expand All @@ -267,7 +278,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
<td><p>Dict[str, str]</p></td>
<td><p>build-time arguments to pass to docker-build</p></td>
</tr>
<tr class="row-even"><td><p>platforms</p></td>
<tr class="row-odd"><td><p>platforms</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>list</p></td>
Expand Down
2 changes: 1 addition & 1 deletion traits/release.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,8 @@ <h2>on_tag_conflict Enumeration Values<a class="headerlink" href="#trait-release
<h2>Dependencies<a class="headerlink" href="#trait-release" title="Link to this heading"></a></h2>
<p>This trait requires the following traits to be declared:</p>
<ul class="simple">
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version trait</span></a></p></li>
<li><p><a class="reference internal" href="component_descriptor.html#trait-component-descriptor"><span class="std std-ref">component_descriptor trait</span></a></p></li>
</ul>
</section>
<p>This trait add release job semantics to the declaring build job.</p>
Expand Down

0 comments on commit 008cd01

Please sign in to comment.