Deployed a33be22 to latest with MkDocs 1.5.3 and mike 1.1.2

SINTEF · Oct 25, 2023 · 9cde16f · 9cde16f
1 parent b5798e0
commit 9cde16f
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 12 deletions.
diff --git a/latest/CHANGELOG/index.html b/latest/CHANGELOG/index.html
@@ -1317,12 +1317,14 @@ <h2 id="unreleased-changes-2023-10-25"><a href="https://github.com/SINTEF/ci-cd/
 </ul>
 <p><strong>Fixed bugs:</strong></p>
 <ul>
+<li>A PR is not opened for CI - Check dependencies <a href="https://github.com/SINTEF/ci-cd/issues/195">#195</a></li>
 <li>Ignore options not parseable <a href="https://github.com/SINTEF/ci-cd/issues/194">#194</a></li>
 </ul>
 <p><strong>Merged pull requests:</strong></p>
 <ul>
 <li>Add project name by default to <code>already_handled_packages</code> <a href="https://github.com/SINTEF/ci-cd/pull/202">#202</a> (<a href="https://github.com/CasperWA">CasperWA</a>)</li>
 <li>Customize branch name <a href="https://github.com/SINTEF/ci-cd/pull/201">#201</a> (<a href="https://github.com/CasperWA">CasperWA</a>)</li>
+<li>Handle package-specifier spacing <a href="https://github.com/SINTEF/ci-cd/pull/197">#197</a> (<a href="https://github.com/CasperWA">CasperWA</a>)</li>
 </ul>
 <h2 id="v252-2023-10-04"><a href="https://github.com/SINTEF/ci-cd/tree/v2.5.2">v2.5.2</a> (2023-10-04)<a class="headerlink" href="#v252-2023-10-04" title="Permanent link">&para;</a></h2>
 <p><a href="https://github.com/SINTEF/ci-cd/compare/v2.5.1...v2.5.2">Full Changelog</a></p>

diff --git a/latest/api_reference/tasks/update_deps/index.html b/latest/api_reference/tasks/update_deps/index.html
@@ -1410,7 +1410,7 @@ <h3 id="ci_cd.tasks.update_deps.parse_ignore_rules" class="doc doc-heading">
 
 
 <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">update_deps</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="n">root_repo_path</span><span class="o">=</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="n">fail_fast</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">pre_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_separator</span><span class="o">=</span><span class="s1">&#39;...&#39;</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">update_deps</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="n">root_repo_path</span><span class="o">=</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="n">fail_fast</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">pre_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_separator</span><span class="o">=</span><span class="s1">&#39;...&#39;</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
 
 
 <a href="#ci_cd.tasks.update_deps.update_deps" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -1444,6 +1444,7 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
             <span class="s2">&quot;Value to use instead of ellipsis (`...`) as a separator in `--ignore` &quot;</span>
             <span class="s2">&quot;key/value-pairs.&quot;</span>
         <span class="p">),</span>
+        <span class="s2">&quot;verbose&quot;</span><span class="p">:</span> <span class="s2">&quot;Whether or not to print debug statements.&quot;</span><span class="p">,</span>
     <span class="p">},</span>
     <span class="n">iterable</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;ignore&quot;</span><span class="p">],</span>
 <span class="p">)</span>
@@ -1454,6 +1455,7 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
     <span class="n">pre_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
     <span class="n">ignore</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">ignore_separator</span><span class="o">=</span><span class="s2">&quot;...&quot;</span><span class="p">,</span>
+    <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Update dependencies in specified Python package&#39;s `pyproject.toml`.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
@@ -1462,10 +1464,16 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
         <span class="n">fail_fast</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">fail_fast</span>  <span class="c1"># type: ignore[no-redef]</span>
         <span class="n">pre_commit</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">pre_commit</span>  <span class="c1"># type: ignore[no-redef]</span>
         <span class="n">ignore_separator</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">ignore_separator</span>  <span class="c1"># type: ignore[no-redef]</span>
+        <span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">verbose</span>  <span class="c1"># type: ignore[no-redef]</span>
 
     <span class="k">if</span> <span class="ow">not</span> <span class="n">ignore</span><span class="p">:</span>
         <span class="n">ignore</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>  <span class="c1"># type: ignore[no-redef]</span>
 
+    <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
+        <span class="n">LOGGER</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+        <span class="n">LOGGER</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">))</span>
+        <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Verbose logging enabled.&quot;</span><span class="p">)</span>
+
     <span class="n">VersionSpec</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span>
         <span class="s2">&quot;VersionSpec&quot;</span><span class="p">,</span>
         <span class="p">[</span>
@@ -1476,6 +1484,7 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
             <span class="s2">&quot;version&quot;</span><span class="p">,</span>
             <span class="s2">&quot;extra_operator_version&quot;</span><span class="p">,</span>
             <span class="s2">&quot;environment_marker&quot;</span><span class="p">,</span>
+            <span class="s2">&quot;spacing&quot;</span><span class="p">,</span>
         <span class="p">],</span>
     <span class="p">)</span>
 
@@ -1526,7 +1535,8 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
     <span class="n">error</span> <span class="o">=</span> <span class="kc">False</span>
     <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">dependencies</span><span class="p">:</span>
         <span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
-            <span class="sa">r</span><span class="s2">&quot;^(?P&lt;full_dependency&gt;(?P&lt;package&gt;[a-zA-Z0-9_.-]+)(?:\s*\[.*\])?)\s*&quot;</span>
+            <span class="sa">r</span><span class="s2">&quot;^(?P&lt;full_dependency&gt;(?P&lt;package&gt;[a-zA-Z0-9_.-]+)(?:\s*\[.*\])?)&quot;</span>
+            <span class="sa">r</span><span class="s2">&quot;(?P&lt;spacing&gt;\s*)&quot;</span>
             <span class="sa">r</span><span class="s2">&quot;(?:&quot;</span>
             <span class="sa">r</span><span class="s2">&quot;(?P&lt;url_version&gt;@\s*\S+)|&quot;</span>
             <span class="sa">r</span><span class="s2">&quot;(?P&lt;operator&gt;&gt;|&lt;|&lt;=|&gt;=|==|!=|~=)\s*&quot;</span>
@@ -1659,16 +1669,27 @@ <h3 id="ci_cd.tasks.update_deps.update_deps" class="doc doc-heading">
             <span class="n">escaped_full_dependency_name</span> <span class="o">=</span> <span class="n">version_spec</span><span class="o">.</span><span class="n">full_dependency</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
                 <span class="s2">&quot;[&quot;</span><span class="p">,</span> <span class="sa">r</span><span class="s2">&quot;\[&quot;</span>
             <span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;]&quot;</span><span class="p">,</span> <span class="sa">r</span><span class="s2">&quot;\]&quot;</span><span class="p">)</span>
-            <span class="n">update_file</span><span class="p">(</span>
-                <span class="n">pyproject_path</span><span class="p">,</span>
-                <span class="p">(</span>
-                    <span class="sa">rf</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">escaped_full_dependency_name</span><span class="si">}</span><span class="s1"> </span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">operator</span><span class="si">}</span><span class="s1">.*&quot;&#39;</span><span class="p">,</span>
-                    <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">full_dependency</span><span class="si">}</span><span class="s1"> &#39;</span>
-                    <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">operator</span><span class="si">}{</span><span class="n">updated_version</span><span class="si">}</span><span class="s2">&quot;</span>
-                    <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">extra_operator_version</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">version_spec</span><span class="o">.</span><span class="n">extra_operator_version</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="si">}</span><span class="s1">&#39;</span>  <span class="c1"># pylint: disable=line-too-long</span>
-                    <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">environment_marker</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">version_spec</span><span class="o">.</span><span class="n">environment_marker</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="si">}</span><span class="s1">&quot;&#39;</span><span class="p">,</span>  <span class="c1"># pylint: disable=line-too-long</span>
-                <span class="p">),</span>
+
+            <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;updated_version: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">updated_version</span><span class="p">)</span>
+            <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
+                <span class="s2">&quot;escaped_full_dependency_name: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">escaped_full_dependency_name</span>
+            <span class="p">)</span>
+
+            <span class="n">pattern_sub_line</span> <span class="o">=</span> <span class="p">(</span>
+                <span class="sa">rf</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">escaped_full_dependency_name</span><span class="si">}{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">spacing</span><span class="si">}</span><span class="s1">&#39;</span>
+                <span class="sa">rf</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">operator</span><span class="si">}</span><span class="s1">.*&quot;&#39;</span>
             <span class="p">)</span>
+            <span class="n">replacement_sub_line</span> <span class="o">=</span> <span class="p">(</span>
+                <span class="sa">f</span><span class="s1">&#39;&quot;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">full_dependency</span><span class="si">}{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">spacing</span><span class="si">}</span><span class="s1">&#39;</span>
+                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">operator</span><span class="si">}{</span><span class="n">updated_version</span><span class="si">}</span><span class="s2">&quot;</span>
+                <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">extra_operator_version</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">version_spec</span><span class="o">.</span><span class="n">extra_operator_version</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="si">}</span><span class="s1">&#39;</span>  <span class="c1"># pylint: disable=line-too-long</span>
+                <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">environment_marker</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">version_spec</span><span class="o">.</span><span class="n">environment_marker</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="si">}</span><span class="s1">&quot;&#39;</span>  <span class="c1"># pylint: disable=line-too-long</span>
+            <span class="p">)</span>
+
+            <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;pattern_sub_line: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">pattern_sub_line</span><span class="p">)</span>
+            <span class="n">LOGGER</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;replacement_sub_line: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">replacement_sub_line</span><span class="p">)</span>
+
+            <span class="n">update_file</span><span class="p">(</span><span class="n">pyproject_path</span><span class="p">,</span> <span class="p">(</span><span class="n">pattern_sub_line</span><span class="p">,</span> <span class="n">replacement_sub_line</span><span class="p">))</span>
             <span class="n">already_handled_packages</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">version_spec</span><span class="o">.</span><span class="n">package</span><span class="p">)</span>
             <span class="n">updated_packages</span><span class="p">[</span><span class="n">version_spec</span><span class="o">.</span><span class="n">full_dependency</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
                 <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">version_spec</span><span class="o">.</span><span class="n">operator</span><span class="si">}{</span><span class="n">updated_version</span><span class="si">}</span><span class="s2">&quot;</span>

diff --git a/latest/hooks/update_pyproject/index.html b/latest/hooks/update_pyproject/index.html
@@ -1098,6 +1098,13 @@ <h2 id="options">Options<a class="headerlink" href="#options" title="Permanent l
 <td style="text-align: center;"></td>
 <td style="text-align: center;"><em>string</em></td>
 </tr>
+<tr>
+<td style="text-align: left;"><code>--verbose</code></td>
+<td style="text-align: left;">Whether or not to print debug statements.</td>
+<td style="text-align: center;">No</td>
+<td style="text-align: center;"><code>False</code></td>
+<td style="text-align: center;"><em>boolean</em></td>
+</tr>
 </tbody>
 </table>
 <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example" title="Permanent link">&para;</a></h2>

diff --git a/latest/search/search_index.json b/latest/search/search_index.json
diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz
diff --git a/latest/workflows/ci_check_pyproject_dependencies/index.html b/latest/workflows/ci_check_pyproject_dependencies/index.html
@@ -1163,6 +1163,13 @@ <h2 id="inputs">Inputs<a class="headerlink" href="#inputs" title="Permanent link
 <td style="text-align: center;"><em>Empty string</em></td>
 <td style="text-align: center;"><em>string</em></td>
 </tr>
+<tr>
+<td style="text-align: left;"><code>debug</code></td>
+<td style="text-align: left;">Whether to run the workflow in debug mode, printing extra debug information.</td>
+<td style="text-align: center;">No</td>
+<td style="text-align: center;"><code>false</code></td>
+<td style="text-align: center;"><em>boolean</em></td>
+</tr>
 </tbody>
 </table>
 <h2 id="secrets">Secrets<a class="headerlink" href="#secrets" title="Permanent link">&para;</a></h2>