deploy: 1a8059f

Festo-se · Sep 18, 2024 · adc8697 · adc8697
1 parent d2b0a91
commit adc8697
Show file tree

Hide file tree

Showing 94 changed files with 5,794 additions and 25,280 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7243dc1fa4dd3d3757d37ab3042d74ef
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/CONTRIBUTING.doctree b/.doctrees/CONTRIBUTING.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/first_steps.doctree b/.doctrees/first_steps.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/known_limitations.doctree b/.doctrees/known_limitations.doctree
diff --git a/.doctrees/maintainers.doctree b/.doctrees/maintainers.doctree
diff --git a/.doctrees/usage/amend.doctree b/.doctrees/usage/amend.doctree
diff --git a/.doctrees/usage/build-public.doctree b/.doctrees/usage/build-public.doctree
diff --git a/.doctrees/usage/index.doctree b/.doctrees/usage/index.doctree
diff --git a/.doctrees/usage/merge-vex.doctree b/.doctrees/usage/merge-vex.doctree
diff --git a/.doctrees/usage/merge.doctree b/.doctrees/usage/merge.doctree
diff --git a/.doctrees/usage/set.doctree b/.doctrees/usage/set.doctree
diff --git a/.doctrees/usage/validate.doctree b/.doctrees/usage/validate.doctree
diff --git a/404.html b/404.html
diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html
@@ -0,0 +1,256 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Contributing &mdash; CycloneDX Editor Validator Tool 0.18.2 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/css/festo-web-essentials.css" />
+      <link rel="stylesheet" type="text/css" href="https://www.festo.com/fonts/fonts.css" />
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=29ae757a"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Maintainers" href="maintainers.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            CycloneDX Editor Validator Tool
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="index.html">CycloneDX Editor Validator Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="first_steps.html">First Steps</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage/index.html">Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="known_limitations.html">Known Limitations</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Further information</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="maintainers.html">Maintainers</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#issues">Issues</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#create-issues">Create Issues</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#solve-issue">Solve Issue</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#make-changes-to-cyclonedx-editor-validator">Make changes to CycloneDX Editor Validator</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#write-new-commands-options-or-arguments">Write new commands, options or arguments</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#submitting-pull-requests">Submitting Pull Requests</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#commit-message-format">Commit Message Format</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#type">Type</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#subject">Subject</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#examples">Examples</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">CycloneDX Editor Validator Tool</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Contributing</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/CONTRIBUTING.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="contributing">
+<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h1>
+<p>Welcome to Festo CycloneDX Editor Validator contributing guide, thank you for investing your time in contributing to our project!
+To get an overview of the project, read the <a class="reference internal" href="index.html"><span class="doc">documentation</span></a>.</p>
+<section id="issues">
+<h2>Issues<a class="headerlink" href="#issues" title="Link to this heading"></a></h2>
+<section id="create-issues">
+<h3>Create Issues<a class="headerlink" href="#create-issues" title="Link to this heading"></a></h3>
+<p>Before submitting, please ensure that you are using the latests code by performing a <code class="code docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code>. Also, please ensure that an issue does not already exists.</p>
+<p>Always include your python version number (<code class="code docutils literal notranslate"><span class="pre">python</span> <span class="pre">--version</span></code>) and the tool version (<code class="code docutils literal notranslate"><span class="pre">cdx-ev</span> <span class="pre">--version</span></code>).</p>
+</section>
+<section id="solve-issue">
+<h3>Solve Issue<a class="headerlink" href="#solve-issue" title="Link to this heading"></a></h3>
+<p>Feel free to assign issues to yourself and make changes to our tool. Please consider the points mentioned <a class="reference internal" href="#make-changes-to-cyclonedx-editor-validator"><span class="std std-ref">here</span></a>.</p>
+</section>
+</section>
+<section id="make-changes-to-cyclonedx-editor-validator">
+<h2>Make changes to CycloneDX Editor Validator<a class="headerlink" href="#make-changes-to-cyclonedx-editor-validator" title="Link to this heading"></a></h2>
+<section id="prerequisites">
+<h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading"></a></h3>
+<ul class="simple">
+<li><p>For compatibility reasons, the code should be compliant to python 3.9 or higher.</p></li>
+<li><p>Make sure to use the latest code by performing a <code class="code docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code>.</p></li>
+<li><p>For a major change it is recommended that you get in touch with us by <a class="reference internal" href="#create-issues"><span class="std std-ref">creating an issue</span></a> to discuss changes prior to dedicating time and resources. This process allows us to better coordinate our efforts and prevent duplication of work.</p></li>
+<li><p>Commit your changes using a descriptive commit message that follows our <a class="reference internal" href="#commit-message-format"><span class="std std-ref">commit message format</span></a>. The same applies for titles of PRs. This is required as we generate our release notes from these messages.</p></li>
+<li><p>Otherwise, feel free to directly [submit a pull request](#submitting-pull-requests).</p></li>
+</ul>
+</section>
+<section id="write-new-commands-options-or-arguments">
+<h3>Write new commands, options or arguments<a class="headerlink" href="#write-new-commands-options-or-arguments" title="Link to this heading"></a></h3>
+<p>Please consider the following rules for commands, options and arguments:</p>
+<table class="docutils align-default">
+<thead>
+<tr class="row-odd"><th class="head"><p>Argument type</p></th>
+<th class="head"><p>Style</p></th>
+<th class="head"><p>Examples</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>Subcommand</p></td>
+<td><p>kebab-case <a class="footnote-reference brackets" href="#f1" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></td>
+<td><p><cite>cdx-ev merge-vex</cite></p></td>
+</tr>
+<tr class="row-odd"><td><p>Option</p></td>
+<td><p>kebab-case</p></td>
+<td><p><cite>cdx-ev --issues-file</cite></p></td>
+</tr>
+<tr class="row-even"><td><p>Option value</p></td>
+<td><p>&lt;kebab-case&gt; <a class="footnote-reference brackets" href="#f1" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></td>
+<td><p><cite>cdx-ev --issues-file &lt;file&gt;</cite></p></td>
+</tr>
+<tr class="row-odd"><td><p>Positional argument</p></td>
+<td><p>&lt;snake-case&gt;</p></td>
+<td><p><cite>cdx-ev merge-vex &lt;sbom_file&gt; &lt;vex_file&gt;</cite></p></td>
+</tr>
+<tr class="row-even"><td><p>Optional position argument</p></td>
+<td><p>[&lt;kebab-case&gt;]</p></td>
+<td><p>No good examples, yet.</p></td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Footnotes:</p>
+<aside class="footnote-list brackets">
+<aside class="footnote brackets" id="f1" role="doc-footnote">
+<span class="label"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></span>
+<span class="backrefs">(<a role="doc-backlink" href="#id1">1</a>,<a role="doc-backlink" href="#id2">2</a>)</span>
+<p>Avoid more than one word.</p>
+</aside>
+</aside>
+</section>
+<section id="submitting-pull-requests">
+<h3>Submitting Pull Requests<a class="headerlink" href="#submitting-pull-requests" title="Link to this heading"></a></h3>
+<p>The following things are to consider before submitting a pull request.</p>
+<ol class="arabic simple">
+<li><p>All <a class="reference external" href="https://github.com/Festo-se/cyclonedx-editor-validator/tree/main/tests">tests</a> should be passing.</p></li>
+<li><p>If you provide a new feature also include tests for it.</p></li>
+<li><p>Please ensure that types are correct according to <a class="reference external" href="mypy_url">mypy</a>.</p></li>
+<li><p>All submitted code should conform to <a class="reference external" href="pep8_url">PEP8</a> and <a class="reference external" href="black_url">black</a>.</p></li>
+<li><p>The code should be python 3.9 compliant.</p></li>
+</ol>
+</section>
+<section id="commit-message-format">
+<h3>Commit Message Format<a class="headerlink" href="#commit-message-format" title="Link to this heading"></a></h3>
+<p>The message format was mainly inspired by the <a class="reference external" href="https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines">guidelines</a> of Angular.</p>
+<p>Please use the following format:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>&lt;type&gt;:<span class="w"> </span>&lt;subject&gt;
+
+&lt;optional<span class="w"> </span>footer<span class="w"> </span>with<span class="w"> </span>additional<span class="w"> </span>details&gt;
+</pre></div>
+</div>
+<section id="type">
+<h4>Type<a class="headerlink" href="#type" title="Link to this heading"></a></h4>
+<p>Must be one of the following:</p>
+<ul class="simple">
+<li><p><strong>feat</strong>: A new feature</p></li>
+<li><p><strong>fix</strong>: A bug fix</p></li>
+<li><p><strong>docs</strong>: Documentation only changes</p></li>
+<li><p><strong>refactor</strong>: A code change that neither fixes a bug nor adds a feature. (e.g., style or performance changes)</p></li>
+<li><p><strong>tests</strong>: Adding missing or correcting existing tests</p></li>
+<li><p><strong>chore</strong>: Changes to the build process or auxiliary tools and libraries such as documentation generation</p></li>
+</ul>
+</section>
+<section id="subject">
+<h4>Subject<a class="headerlink" href="#subject" title="Link to this heading"></a></h4>
+<p>The subject contains succinct description of the change:</p>
+<ul class="simple">
+<li><p>Use the imperative, present tense: “change” not “changed” nor “changes”</p></li>
+<li><p>Don’t capitalize first letter</p></li>
+<li><p>No dot (.) at the end</p></li>
+<li><p>Do not describe the reason of the change, describe the content of the change (what, not why).</p></li>
+</ul>
+</section>
+<section id="examples">
+<h4>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h4>
+<p><code class="code docutils literal notranslate"><span class="pre">fix:</span> <span class="pre">do</span> <span class="pre">not</span> <span class="pre">add</span> <span class="pre">license</span> <span class="pre">option</span> <span class="pre">to</span> <span class="pre">default</span> <span class="pre">operations</span></code></p>
+<p><code class="code docutils literal notranslate"><span class="pre">feat:</span> <span class="pre">add</span> <span class="pre">'amend'</span> <span class="pre">option</span></code></p>
+<p><code class="code docutils literal notranslate"><span class="pre">refactor:</span> <span class="pre">apply</span> <span class="pre">black</span></code></p>
+</section>
+</section>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="maintainers.html" class="btn btn-neutral float-left" title="Maintainers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Festo SE &amp; Co. KG.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>