deploy: bb1539d

Author: github-actions[bot]

404.html

@@ -279,26 +279,6 @@
 
 
 
-    <li class="md-nav__item">
-      <a href="/getting_started/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Getting Started
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
 
 
 
@@ -307,10 +287,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 
 
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -321,8 +301,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2">
             <span class="md-nav__icon md-icon"></span>
             Commands
           </label>
@@ -599,10 +579,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
 
 
-          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -613,8 +593,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_6">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_5">
             <span class="md-nav__icon md-icon"></span>
             Tutorials
           </label>

commands/bump/index.html

@@ -286,26 +286,6 @@
 
 
 
-  
-  
-    <li class="md-nav__item">
-      <a href="../../getting_started/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Getting Started
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
 
 
 
@@ -318,10 +298,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
 
 
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -332,8 +312,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_3">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_2">
             <span class="md-nav__icon md-icon"></span>
             Commands
           </label>
@@ -997,10 +977,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
 
 
-          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -1011,8 +991,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_6">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_5">
             <span class="md-nav__icon md-icon"></span>
             Tutorials
           </label>
@@ -1774,7 +1754,7 @@ <h3 id="-changelog"><code>--changelog</code><a class="headerlink" href="#-change
 <h3 id="-prerelease"><code>--prerelease</code><a class="headerlink" href="#-prerelease" title="Permanent link">&para;</a></h3>
 <p>The bump is a pre-release bump, meaning that in addition to a possible version bump the new version receives a
 pre-release segment compatible with the bump’s version scheme, where the segment consist of a <em>phase</em> and a
-non-negative number. Supported options for <code>--prerelease</code> are the following phase names  <code>alpha</code>, <code>beta</code>, or
+non-negative number. Supported options for <code>--prerelease</code> are the following phase names <code>alpha</code>, <code>beta</code>, or
 <code>rc</code> (release candidate). For more details, refer to the
 <a href="https://packaging.python.org/en/latest/specifications/version-specifiers/#pre-releases">Python Packaging User Guide</a>.</p>
 <p>Note that as per <a href="https://semver.org/#spec-item-9">semantic versioning spec</a></p>
@@ -1858,7 +1838,7 @@ <h3 id="-increment-mode"><code>--increment-mode</code><a class="headerlink" href
 </tbody>
 </table>
 <h3 id="-check-consistency"><code>--check-consistency</code><a class="headerlink" href="#-check-consistency" title="Permanent link">&para;</a></h3>
-<p>Check whether the versions defined in <code>version_files</code> and the version in commitizen
+<p>Check whether the versions defined in <code>version_files</code> and the version in Commitizen
 configuration are consistent before bumping version.</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>bump<span class="w"> </span>--check-consistency
 </code></pre></div>
@@ -1878,7 +1858,7 @@ <h3 id="-check-consistency"><code>--check-consistency</code><a class="headerlink
 
 <span class="n">setup</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s2">&quot;1.0.5&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
 </code></pre></div>
-<p>If <code>--check-consistency</code> is used, commitizen will check whether the current version in <code>pyproject.toml</code>
+<p>If <code>--check-consistency</code> is used, Commitizen will check whether the current version in <code>pyproject.toml</code>
 exists in all version_files and find out it does not exist in <code>setup.py</code> and fails.
 However, it will still update <code>pyproject.toml</code> and <code>src/__version__.py</code>.</p>
 <p>To fix it, you'll first <code>git checkout .</code> to reset to the status before trying to bump and update
@@ -1893,9 +1873,9 @@ <h3 id="-local-version"><code>--local-version</code><a class="headerlink" href="
 </code></pre></div>
 <p>If <code>--local-version</code> is used, it will bump only the local version <code>0.1.0</code> and keep the public version <code>5.3.5</code> intact, bumping to the version <code>5.3.5+0.2.0</code>.</p>
 <h3 id="-annotated-tag"><code>--annotated-tag</code><a class="headerlink" href="#-annotated-tag" title="Permanent link">&para;</a></h3>
-<p>If <code>--annotated-tag</code> is used, commitizen will create annotated tags. Also available via configuration, in <code>pyproject.toml</code> or <code>.cz.toml</code>.</p>
+<p>If <code>--annotated-tag</code> is used, Commitizen will create annotated tags. It is also available via configuration, in <code>pyproject.toml</code> or <code>.cz.toml</code>.</p>
 <h3 id="-annotated-tag-message"><code>--annotated-tag-message</code><a class="headerlink" href="#-annotated-tag-message" title="Permanent link">&para;</a></h3>
-<p>If <code>--annotated-tag-message</code> is used, commitizen will create annotated tags with the given message.</p>
+<p>If <code>--annotated-tag-message</code> is used, Commitizen will create annotated tags with the given message.</p>
 <h3 id="-changelog-to-stdout"><code>--changelog-to-stdout</code><a class="headerlink" href="#-changelog-to-stdout" title="Permanent link">&para;</a></h3>
 <p>If <code>--changelog-to-stdout</code> is used, the incremental changelog generated by the bump
 will be sent to the stdout, and any other message generated by the bump will be
@@ -2013,10 +1993,10 @@ <h3 id="-allow-no-commit"><code>--allow-no-commit</code><a class="headerlink" hr
 cz<span class="w"> </span>bump<span class="w"> </span>--allow-no-commit<span class="w"> </span><span class="m">2</span>.0.0
 </code></pre></div>
 <h2 id="avoid-raising-errors">Avoid raising errors<a class="headerlink" href="#avoid-raising-errors" title="Permanent link">&para;</a></h2>
-<p>Some situations from commitizen raise an exit code different than 0.
-If the error code is different than 0, any CI or script running commitizen might be interrupted.</p>
+<p>Some situations from Commitizen raise an exit code different from 0.
+If the error code is different from 0, any CI or script running Commitizen might be interrupted.</p>
 <p>If you have a special use case, where you don't want to raise one of this error codes, you can
-tell commitizen to not raise them.</p>
+tell Commitizen to not raise them.</p>
 <h3 id="recommended-use-case">Recommended use case<a class="headerlink" href="#recommended-use-case" title="Permanent link">&para;</a></h3>
 <p>At the moment, we've identified that the most common error code to skip is</p>
 <table>
@@ -2038,24 +2018,24 @@ <h3 id="recommended-use-case">Recommended use case<a class="headerlink" href="#r
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>-nr<span class="w"> </span><span class="m">21</span><span class="w"> </span>bump
 </code></pre></div>
 <h3 id="easy-way">Easy way<a class="headerlink" href="#easy-way" title="Permanent link">&para;</a></h3>
-<p>Check which error code was raised by commitizen by running in the terminal</p>
+<p>Check which error code was raised by Commitizen by running in the terminal</p>
 <div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span><span class="nv">$?</span>
 </code></pre></div>
 <p>The output should be an integer like this</p>
 <div class="highlight"><pre><span></span><code><span class="m">3</span>
 </code></pre></div>
-<p>And then you can tell commitizen to ignore it:</p>
+<p>And then you can tell Commitizen to ignore it:</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--no-raise<span class="w"> </span><span class="m">3</span>
 </code></pre></div>
-<p>You can tell commitizen to skip more than one if needed:</p>
+<p>You can tell Commitizen to skip more than one if needed:</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--no-raise<span class="w"> </span><span class="m">3</span>,4,5
 </code></pre></div>
 <h3 id="longer-way">Longer way<a class="headerlink" href="#longer-way" title="Permanent link">&para;</a></h3>
 <p>Check the list of <a href="../../exit_codes/">exit_codes</a> and understand which one you have
 to skip and why.</p>
 <p>Remember to document somewhere this, because you'll forget.</p>
 <p>For example if the system raises a <code>NoneIncrementExit</code> error, you look it up
-on the list and then you can use the exit code:</p>
+on the list, and then you can use the exit code:</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>-nr<span class="w"> </span><span class="m">21</span><span class="w"> </span>bump
 </code></pre></div>
 <h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
@@ -2065,7 +2045,7 @@ <h3 id="tag_format"><code>tag_format</code><a class="headerlink" href="#tag_form
 <ul>
 <li><code>cz bump</code>: Find previous release tag (exact match) and generate new tag.</li>
 <li>Find previous release tags in <code>cz changelog</code>.</li>
-<li>If <code>--incremental</code>: Using latest version found in the changelog, scan existing Git tags with 89\% similarity match.</li>
+<li>If <code>--incremental</code>: Using the latest version found in the changelog, scan existing Git tags with 89\% similarity match.</li>
 <li><code>--rev-range</code> is converted to Git tag names with <code>tag_format</code> before searching Git history.</li>
 <li>If the <code>scm</code> <code>version_provider</code> is used, it uses different regexes to find the previous version tags:</li>
 <li>If <code>tag_format</code> is set to <code>$version</code> (default): <code>VersionProtocol.parser</code> (allows <code>v</code> prefix)</li>
@@ -2142,7 +2122,7 @@ <h3 id="version_files"><code>version_files</code> *<a class="headerlink" href="#
 <hr />
 <h3 id="bump_message"><code>bump_message</code><a class="headerlink" href="#bump_message" title="Permanent link">&para;</a></h3>
 <p>Template used to specify the commit message generated when bumping.</p>
-<p>defaults to: <code>bump: version $current_version → $new_version</code></p>
+<p>Defaults to: <code>bump: version $current_version → $new_version</code></p>
 <table>
 <thead>
 <tr>
@@ -2169,25 +2149,25 @@ <h3 id="bump_message"><code>bump_message</code><a class="headerlink" href="#bump
 <hr />
 <h3 id="update_changelog_on_bump"><code>update_changelog_on_bump</code><a class="headerlink" href="#update_changelog_on_bump" title="Permanent link">&para;</a></h3>
 <p>When set to <code>true</code> the changelog is always updated incrementally when running <code>cz bump</code>, so the user does not have to provide the <code>--changelog</code> flag every time.</p>
-<p>defaults to: <code>false</code></p>
+<p>Defaults to: <code>false</code></p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="n">update_changelog_on_bump</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
 <hr />
 <h3 id="annotated_tag"><code>annotated_tag</code><a class="headerlink" href="#annotated_tag" title="Permanent link">&para;</a></h3>
-<p>When set to <code>true</code> commitizen will create annotated tags.</p>
+<p>When set to <code>true</code>, Commitizen will create annotated tags.</p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="n">annotated_tag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
 <hr />
 <h3 id="gpg_sign"><code>gpg_sign</code><a class="headerlink" href="#gpg_sign" title="Permanent link">&para;</a></h3>
-<p>When set to <code>true</code> commitizen will create gpg signed tags.</p>
+<p>When set to <code>true</code>, Commitizen will create gpg signed tags.</p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="n">gpg_sign</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
 <hr />
 <h3 id="major_version_zero"><code>major_version_zero</code><a class="headerlink" href="#major_version_zero" title="Permanent link">&para;</a></h3>
-<p>When set to <code>true</code> commitizen will keep the major version at zero.
+<p>When set to <code>true</code>, Commitizen will keep the major version at zero.
 Useful during the initial development stage of your project.</p>
 <p>Defaults to: <code>false</code></p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>