Skip to content

Commit 8d5e57b

Browse files
committed
Deploying to gh-pages from @ d214704 🚀
1 parent 5d2b9af commit 8d5e57b

15 files changed

+757
-701
lines changed

commands/bump/index.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -579,10 +579,10 @@
579579
<ul class="md-nav__list">
580580

581581
<li class="md-nav__item">
582-
<a href="#-files-only" class="md-nav__link">
582+
<a href="#-version-files-only" class="md-nav__link">
583583
<span class="md-ellipsis">
584584

585-
--files-only
585+
--version-files-only
586586

587587
</span>
588588
</a>
@@ -2503,10 +2503,10 @@
25032503
<ul class="md-nav__list">
25042504

25052505
<li class="md-nav__item">
2506-
<a href="#-files-only" class="md-nav__link">
2506+
<a href="#-version-files-only" class="md-nav__link">
25072507
<span class="md-ellipsis">
25082508

2509-
--files-only
2509+
--version-files-only
25102510

25112511
</span>
25122512
</a>
@@ -2888,6 +2888,18 @@ <h3 id="-version-scheme"><code>--version-scheme</code><a class="headerlink" href
28882888
</tbody>
28892889
</table>
28902890
</div>
2891+
<div class="admonition note">
2892+
<p class="admonition-title">Incomplete Version Handling</p>
2893+
<p>Commitizen treats a three-part version (major.minor.patch) as complete.
2894+
If your configured version is incomplete (for example, <code>1</code> or <code>1.2</code>), Commitizen pads missing parts with zeros when it needs <code>major/minor/patch</code> for tag formatting.
2895+
The tag output depends on your <code>tag_format</code>: formats using <code>${version}</code> keep <code>1</code>/<code>1.2</code>, while formats using <code>${major}.${minor}.${patch}</code> will render <code>1.0.0</code>/<code>1.2.0</code>.</p>
2896+
<p>When bumping from an incomplete version, Commitizen looks for the latest existing tag that matches the provided release prefix.
2897+
For example, if the current version is <code>1.2</code> and the latest <code>1.2.x</code> tag is <code>1.2.3</code>, then a patch bump yields <code>1.2.4</code> and a minor bump yields <code>1.3.0</code>.</p>
2898+
</div>
2899+
<div class="admonition tip">
2900+
<p class="admonition-title">Tip</p>
2901+
<p>To control the behaviour of bumping and version parsing, you may implement your own <code>version_scheme</code> by inheriting from <code>commitizen.version_schemes.BaseVersion</code> or use an existing plugin package.</p>
2902+
</div>
28912903
<h3 id="pep440-version-examples">PEP440 Version Examples<a class="headerlink" href="#pep440-version-examples" title="Permanent link">&para;</a></h3>
28922904
<p>Commitizen supports the <a href="https://www.python.org/dev/peps/pep-0440/">PEP 440</a> version format, which includes several version types. Here are examples of each:</p>
28932905
<h4 id="standard-releases">Standard Releases<a class="headerlink" href="#standard-releases" title="Permanent link">&para;</a></h4>
@@ -2921,9 +2933,9 @@ <h4 id="combined-pre-release-and-development">Combined Pre-release and Developme
29212933
</blockquote>
29222934
<h2 id="command-line-options">Command line options<a class="headerlink" href="#command-line-options" title="Permanent link">&para;</a></h2>
29232935
<p><img alt="cz bump --help" src="../../images/cli_help/cz_bump___help.svg" /></p>
2924-
<h3 id="-files-only"><code>--files-only</code><a class="headerlink" href="#-files-only" title="Permanent link">&para;</a></h3>
2936+
<h3 id="-version-files-only"><code>--version-files-only</code><a class="headerlink" href="#-version-files-only" title="Permanent link">&para;</a></h3>
29252937
<p>Bumps the version in the files defined in <a href="../../config/bump/#version_files"><code>version_files</code></a> without creating a commit and tag on the git repository.</p>
2926-
<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>bump<span class="w"> </span>--files-only
2938+
<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>bump<span class="w"> </span>--version-files-only
29272939
</code></pre></div>
29282940
<h3 id="-changelog"><code>--changelog</code><a class="headerlink" href="#-changelog" title="Permanent link">&para;</a></h3>
29292941
<p>Generate a <strong>changelog</strong> along with the new version and tag when bumping. See <a href="../changelog/">changelog</a> for more details.</p>
@@ -3303,7 +3315,7 @@ <h3 id="-yes"><code>--yes</code><a class="headerlink" href="#-yes" title="Perman
33033315
<span class="md-icon" title="Last update">
33043316
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
33053317
</span>
3306-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="January 5, 2026 12:23:24 UTC">January 5, 2026</span>
3318+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 1, 2026 10:53:42 UTC">February 1, 2026</span>
33073319
</span>
33083320

33093321

0 commit comments

Comments
 (0)