Skip to content

Commit a5b8e3f

Browse files
committed
Deploying to gh-pages from @ 30a0128 🚀
1 parent e0f5d2e commit a5b8e3f

File tree

3 files changed

+4
-7
lines changed

3 files changed

+4
-7
lines changed

Diff for: api/docker_tag_updater.helpers.html

+2-3
Original file line numberDiff line numberDiff line change
@@ -249,14 +249,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
249249
<p>A set of helpers.</p>
250250
<dl class="py function">
251251
<dt class="sig sig-object py" id="docker_tag_updater.helpers.parse_version">
252-
<span class="sig-name descname"><span class="pre">parse_version</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{'default':</span> <span class="pre">'v?(?:ersion-)?(?P&lt;major&gt;\\\\d+)\\\\.(?P&lt;minor&gt;\\\\d+)\\\\.(?P&lt;patch&gt;\\\\d+).*',</span> <span class="pre">'lscr':</span> <span class="pre">'v?(?:ersion-)?(?P&lt;major&gt;\\\\d+)\\\\.(?P&lt;minor&gt;\\\\d+)\\\\.(?P&lt;patch&gt;\\\\d+)(?:\\\\.(?P&lt;prerelease&gt;\\\\d+))?(?:-ls(?P&lt;build&gt;\\\\d+))?'}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'default'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.helpers.parse_version" title="Link to this definition">#</a></dt>
252+
<span class="sig-name descname"><span class="pre">parse_version</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{'default':</span> <span class="pre">'v?(?:ersion-)?(?P&lt;major&gt;\\\\d+)\\\\.(?P&lt;minor&gt;\\\\d+)\\\\.(?P&lt;patch&gt;\\\\d+).*',</span> <span class="pre">'lscr':</span> <span class="pre">'v?(?:ersion-)?(?P&lt;major&gt;\\\\d+)\\\\.(?P&lt;minor&gt;\\\\d+)\\\\.(?P&lt;patch&gt;\\\\d+)(?:\\\\.(?P&lt;prerelease&gt;\\\\d+))?(?:-ls(?P&lt;build&gt;\\\\d+))?'}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'default'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.helpers.parse_version" title="Link to this definition">#</a></dt>
253253
<dd><p>Parse the version according to a regex rule.</p>
254254
<dl class="field-list simple">
255255
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
256256
<dd class="field-odd"><ul class="simple">
257257
<li><p><strong>version</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – A semver string.</p></li>
258-
<li><p><strong>rules</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="docker_tag_updater.helpers.regex_rules.html#docker_tag_updater.helpers.regex_rules.RegexRules" title="docker_tag_updater.helpers.regex_rules.RegexRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">RegexRules</span></code></a></span>) – A set of RegexRules.
259-
Default <code class="docutils literal notranslate"><span class="pre">RegexRules[default</span> <span class="pre">lscr]</span></code>.</p></li>
258+
<li><p><strong>rules</strong> – A set of RegexRules.</p></li>
260259
<li><p><strong>rule_name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule, or its alias.
261260
Default <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
262261
</ul>

Diff for: api/docker_tag_updater.skopeo.html

+1-3
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@
227227
<p>This module defines the functions that are used for the CLI tool (image-version-checker).</p>
228228
<dl class="py function">
229229
<dt class="sig sig-object py" id="docker_tag_updater.skopeo.compare_versions">
230-
<span class="sig-name descname"><span class="pre">compare_versions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_ver</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_ver</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.skopeo.compare_versions" title="Link to this definition">#</a></dt>
230+
<span class="sig-name descname"><span class="pre">compare_versions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_ver</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_ver</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.skopeo.compare_versions" title="Link to this definition">#</a></dt>
231231
<dd><p>Compare the current and newest semver, return the neweset version.</p>
232232
<p>The comparision will be done using the python-semver package. A simple comparison of
233233
the major, minor, and patch versions only, is implemented in this version.</p>
@@ -238,8 +238,6 @@
238238
<li><p><strong>target_ver</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The semver string of the target.</p></li>
239239
<li><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – Name of the <code class="docutils literal notranslate"><span class="pre">RegexRules</span></code> rule to parse these semver strings.
240240
Default <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
241-
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – (Currently unimplemented).
242-
Default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
243241
<li><p><strong>verbose</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – Specify the verbosity of the inspector function.
244242
Default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
245243
</ul>

0 commit comments

Comments
 (0)