Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gardener-robot-ci-3 committed Oct 23, 2023
1 parent 4606c0c commit 6513639
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 7 deletions.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

15 changes: 11 additions & 4 deletions traits/component_descriptor.html
Original file line number Diff line number Diff line change
Expand Up @@ -222,15 +222,22 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
<td><p>the component descriptor context repository cfg name (for component descriptor v2).
If not configured, the CICD-landscape’s default ctx will be used.</p></td>
</tr>
<tr class="row-even"><td><p>snapshot_ctx_repository</p></td>
<tr class="row-even"><td><p>ocm_repository</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p>the Component Descriptor OCM Repository url used for publishing.
instead of repository-url, may also be the name of a cfg-element.</p></td>
</tr>
<tr class="row-odd"><td><p>snapshot_ctx_repository</p></td>
<td><p>no</p></td>
<td><p>None</p></td>
<td><p>str</p></td>
<td><p>the component descriptor context repository cfg name for snapshot-component-descriptors,
i.e. component descriptors that are not for release-versions.
If not configured, the CICD_landscape’s default ctx will be used.</p></td>
</tr>
<tr class="row-odd"><td><p>component_labels</p></td>
<tr class="row-even"><td><p>component_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 @@ -239,7 +246,7 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
<td><p>List[Label]</p></td>
<td><p>a list of labels to add to the component in the base Component Descriptor</p></td>
</tr>
<tr class="row-even"><td><p>inputs</p></td>
<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="p p-Indicator">[]</span>
</pre></div>
Expand All @@ -248,7 +255,7 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
<td><p>List[StepInput]</p></td>
<td><p>inputs to expose to component-descriptor step</p></td>
</tr>
<tr class="row-odd"><td><p>ocm_repository_mappings</p></td>
<tr class="row-even"><td><p>ocm_repository_mappings</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 Down
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
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 6513639

Please sign in to comment.