Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gardener-robot-ci-1 committed Nov 22, 2023
1 parent d5e9a76 commit ce13dca
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 14 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="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>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version 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
34 changes: 23 additions & 11 deletions traits/publish.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,15 +173,27 @@ <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>name of the registry config to use when pushing the image (see cc-utils).</p></td>
<td><p>name of the registry config to use when pushing the image.</p></td>
</tr>
<tr class="row-odd"><td><p>image</p></td>
<td><p>yes</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p>image reference to publish the created container image to.</p></td>
</tr>
<tr class="row-even"><td><p>inputs</p></td>
<tr class="row-even"><td><p>extra_push_targets</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>
</div>
</p></td>
<td><p>list</p></td>
<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>
</tr>
<tr class="row-odd"><td><p>inputs</p></td>
<td><p>no</p></td>
<td><p><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">repos</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">null</span>
<span class="nt">steps</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
Expand All @@ -191,7 +203,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
<td><p>dict</p></td>
<td><p>configures the inputs that are made available to image build</p></td>
</tr>
<tr class="row-odd"><td><p>prebuild_hook</p></td>
<tr class="row-even"><td><p>prebuild_hook</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
Expand All @@ -207,37 +219,37 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
dockerd will be available and running (docker excecutable accessible from PATH).</p>
</p></td>
</tr>
<tr class="row-even"><td><p>tag_as_latest</p></td>
<tr class="row-odd"><td><p>tag_as_latest</p></td>
<td><p>no</p></td>
<td><p>False</p></td>
<td><p>bool</p></td>
<td><p>whether or not published container images should <strong>also</strong> be labeled as latest</p></td>
</tr>
<tr class="row-odd"><td><p>tag_template</p></td>
<tr class="row-even"><td><p>tag_template</p></td>
<td><p>no</p></td>
<td><p>${EFFECTIVE_VERSION}</p></td>
<td><p>str</p></td>
<td><p>the template to use for the image-tag (only variable: EFFECTIVE_VERSION)</p></td>
</tr>
<tr class="row-even"><td><p>dockerfile</p></td>
<tr class="row-odd"><td><p>dockerfile</p></td>
<td><p>no</p></td>
<td><p>Dockerfile</p></td>
<td><p>str</p></td>
<td><p>the file to use for building the container image</p></td>
</tr>
<tr class="row-odd"><td><p>dir</p></td>
<tr class="row-even"><td><p>dir</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p>the relative path to the container image build file</p></td>
</tr>
<tr class="row-even"><td><p>target</p></td>
<tr class="row-odd"><td><p>target</p></td>
<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>
</tr>
<tr class="row-odd"><td><p>resource_labels</p></td>
<tr class="row-even"><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 @@ -246,7 +258,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-even"><td><p>build_args</p></td>
<tr class="row-odd"><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 @@ -255,7 +267,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-odd"><td><p>platforms</p></td>
<tr class="row-even"><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="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>
<li><p><a class="reference internal" href="version.html#trait-version"><span class="std std-ref">version 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 ce13dca

Please sign in to comment.