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 Oct 20, 2023
1 parent 180732d commit 5d27482
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions traits/component_descriptor.html
Original file line number Diff line number Diff line change
Expand Up @@ -254,20 +254,21 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
</pre></div>
</div>
</p></td>
<td><p>List[OcmLookupMapping]</p></td>
<td><p>List[OcmResolverConfig]</p></td>
<td><p><p>used to explicitly configure where to lookup component descriptors. Example:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ocm_repo_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocm_repo_url</span>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repository</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocm_repo_url</span>
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.com/some-org/</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ocm_repo_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocm_repo_url</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repository</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocm_repo_url</span>
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.com/another-org/</span>
<span class="w"> </span><span class="nt">priority</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># default</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ocm_repo_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">another_ocm_repo_url</span>
<span class="w"> </span><span class="nt">component_names</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.com/yet-another-org/</span>
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repository</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">another_ocm_repo_url</span>
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.com/yet-another-org/</span>
</pre></div>
</div>
<p>If not given, a default mapping will be applied that is equivalent to the following:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ocm_repo_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;ctx_repository_base_url&gt;</span>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repository</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;ctx_repository_base_url&gt;</span>
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;&#39;</span>
<span class="w"> </span><span class="nt">priority</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
</pre></div>
</div>
<div class="admonition note">
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="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
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 5d27482

Please sign in to comment.