update documentation

pipeline_job.html

@@ -225,7 +225,7 @@ <h3>Repository Attributes<a class="headerlink" href="#repository-attributes" tit
 </pre></div>
 </div>
 </p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p>The name of github configs to provide for authentication of submodules which are not stored
 on the same git server as the repository.
 The config used by the repository itself is included by default.

traits/component_descriptor.html

@@ -255,7 +255,7 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
 </pre></div>
 </div>
 </p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p>steps that need to be run prior to running component-descriptor-step</p></td>
 </tr>
 <tr class="row-even"><td><p>ocm_repository_mappings</p></td>
@@ -264,7 +264,7 @@ <h1><em>component_descriptor</em> Trait<a class="headerlink" href="#component-de
 </pre></div>
 </div>
 </p></td>
-<td><p>list</p></td>
+<td><p>List[OcmRepositoryMappingEntry]</p></td>
 <td><p><p>used to explicitly configure where to lookup component descriptors. If given,
 ocm_repository <em>must</em> be defined.</p>
 <p><strong>Example:</strong></p>

traits/draft_release.html

@@ -120,8 +120,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

traits/image_scan.html

@@ -155,7 +155,7 @@ <h1><em>image_scan</em> Trait<a class="headerlink" href="#image-scan-trait" titl
 <tr class="row-even"><td><p>github_issue_templates</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[GithubIssueTemplateCfg]</p></td>
 <td><p><p>use to configure custom github-issue-templates (sub-attr: <code class="code docutils literal notranslate"><span class="pre">body</span></code>)
 use python3’s format-str syntax</p>
 <div class="literal-block-wrapper docutils container" id="id1">
@@ -177,7 +177,7 @@ <h1><em>image_scan</em> Trait<a class="headerlink" href="#image-scan-trait" titl
 <tr class="row-odd"><td><p>github_issue_labels_to_preserve</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p>optional list of regexes for labels that will never be removed upon ticket-update</p></td>
 </tr>
 <tr class="row-even"><td><p>email_recipients</p></td>
@@ -248,7 +248,7 @@ <h2>clam_av <em>(ClamAVScanCfg)</em> Attributes<a class="headerlink" href="#trai
 <tr class="row-odd"><td><p>rescore</p></td>
 <td><p>no</p></td>
 <td><p>()</p></td>
-<td><p>list</p></td>
+<td><p>List[ClamAVRescoringEntry]</p></td>
 <td><p>rescoring hints (e.g. to mark false-positives / accept certain scan-abortions)</p></td>
 </tr>
 <tr class="row-even"><td><p>timeout</p></td>

traits/publish.html

@@ -130,7 +130,7 @@ <h1><em>publish</em> Trait<a class="headerlink" href="#publish-trait" title="Lin
 <tr class="row-odd"><td><p>platforms</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p><p>if defined, all image-builds will be done for each of the specified platforms, which
 may result in cross-platform builds. Only supported if using <code class="code docutils literal notranslate"><span class="pre">docker-buildx</span></code> as oci-builder.</p>
 <p>As an implementation detail that may change in the future, multiarch/quemu-user-static
@@ -161,7 +161,7 @@ <h1><em>publish</em> Trait<a class="headerlink" href="#publish-trait" title="Lin
 <tr class="row-even"><td><p>helmcharts</p></td>
 <td><p>no</p></td>
 <td><p>()</p></td>
-<td><p>tuple</p></td>
+<td><p>List[HelmchartCfg]</p></td>
 <td><p></p></td>
 </tr>
 </tbody>
@@ -195,7 +195,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
 </pre></div>
 </div>
 </p></td>
-<td><p>list</p></td>
+<td><p>List[str]</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).
@@ -262,7 +262,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
 <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>List[TargetSpec]</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.
@@ -289,7 +289,7 @@ <h2>dockerimages.&lt;user-chosen&gt; <em>(PublishDockerImageDescriptor)</em> Att
 <tr class="row-odd"><td><p>platforms</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p><p>If <code class="code docutils literal notranslate"><span class="pre">platforms</span></code> is defined at toplevel, then defining it again for a single image-build
 can be done in order to only build this image for a subset of platforms.</p>
 <p>see toplevel documentation for <code class="code docutils literal notranslate"><span class="pre">platforms</span></code> for reference.</p>

traits/release.html

@@ -115,7 +115,7 @@ <h1><em>release</em> Trait<a class="headerlink" href="#release-trait" title="Lin
 </pre></div>
 </div>
 </p></td>
-<td><p>list</p></td>
+<td><p>List[Asset]</p></td>
 <td><p>additional release-assets to publish. For now it is only supported to define
 build-step-logs as additional sources within component-descriptor.</p></td>
 </tr>
@@ -310,8 +310,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>

traits/scan_sources.html

@@ -159,7 +159,7 @@ <h1><em>scan_sources</em> Trait<a class="headerlink" href="#scan-sources-trait"
 <tr class="row-even"><td><p>github_issue_templates</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[GithubIssueTemplateCfg]</p></td>
 <td><p>use to configure custom github-issue-templates (sub-attr: <code class="code docutils literal notranslate"><span class="pre">body</span></code>)
 use python3’s format-str syntax
 available variables:
@@ -176,7 +176,7 @@ <h1><em>scan_sources</em> Trait<a class="headerlink" href="#scan-sources-trait"
 <tr class="row-odd"><td><p>github_issue_labels_to_preserve</p></td>
 <td><p>no</p></td>
 <td><p>None</p></td>
-<td><p>list</p></td>
+<td><p>List[str]</p></td>
 <td><p>optional list of regexes for labels that will never be removed upon ticket-update</p></td>
 </tr>
 </tbody>