Skip to content

Commit 4f64a1d

Browse files
Deploying to gh-pages from @ b4f4209 🚀
1 parent 9fa430c commit 4f64a1d

8 files changed

Lines changed: 184 additions & 52 deletions

File tree

commands/version/index.html

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,39 @@
660660
</span>
661661
</a>
662662

663+
</li>
664+
665+
<li class="md-nav__item">
666+
<a href="#project-version-and-scheme" class="md-nav__link">
667+
<span class="md-ellipsis">
668+
669+
Project version and scheme
670+
671+
</span>
672+
</a>
673+
674+
</li>
675+
676+
<li class="md-nav__item">
677+
<a href="#components-and-next-version" class="md-nav__link">
678+
<span class="md-ellipsis">
679+
680+
Components and next version
681+
682+
</span>
683+
</a>
684+
685+
</li>
686+
687+
<li class="md-nav__item">
688+
<a href="#examples" class="md-nav__link">
689+
<span class="md-ellipsis">
690+
691+
Examples
692+
693+
</span>
694+
</a>
695+
663696
</li>
664697

665698
</ul>
@@ -2012,6 +2045,39 @@
20122045
</span>
20132046
</a>
20142047

2048+
</li>
2049+
2050+
<li class="md-nav__item">
2051+
<a href="#project-version-and-scheme" class="md-nav__link">
2052+
<span class="md-ellipsis">
2053+
2054+
Project version and scheme
2055+
2056+
</span>
2057+
</a>
2058+
2059+
</li>
2060+
2061+
<li class="md-nav__item">
2062+
<a href="#components-and-next-version" class="md-nav__link">
2063+
<span class="md-ellipsis">
2064+
2065+
Components and next version
2066+
2067+
</span>
2068+
</a>
2069+
2070+
</li>
2071+
2072+
<li class="md-nav__item">
2073+
<a href="#examples" class="md-nav__link">
2074+
<span class="md-ellipsis">
2075+
2076+
Examples
2077+
2078+
</span>
2079+
</a>
2080+
20152081
</li>
20162082

20172083
</ul>
@@ -2033,9 +2099,27 @@
20332099

20342100
<h1>version</h1>
20352101

2036-
<p>Get the version of the installed Commitizen or the current project (default: installed commitizen)</p>
2102+
<p>Get the version of the installed Commitizen or the current project (default: installed commitizen).</p>
20372103
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
20382104
<p><img alt="cz version --help" src="../../images/cli_help/cz_version___help.svg" /></p>
2105+
<h2 id="project-version-and-scheme">Project version and scheme<a class="headerlink" href="#project-version-and-scheme" title="Permanent link">&para;</a></h2>
2106+
<ul>
2107+
<li><strong><code>cz version --project</code></strong> prints the version from your configured <a href="../../config/version_provider/">version provider</a>.</li>
2108+
<li><strong><code>cz version MANUAL_VERSION</code></strong> (optional positional) uses that string instead of the provider, so you can try how your configured scheme parses and formats it.</li>
2109+
</ul>
2110+
<h2 id="components-and-next-version">Components and next version<a class="headerlink" href="#components-and-next-version" title="Permanent link">&para;</a></h2>
2111+
<ul>
2112+
<li><strong><code>--major</code></strong>, <strong><code>--minor</code></strong>, <strong><code>--patch</code></strong>: print only that component of the (possibly manual) project version. Requires <code>--project</code>, <code>--verbose</code>, or a manual version.</li>
2113+
<li><strong><code>--next</code> <code>[MAJOR|MINOR|PATCH|NONE]</code></strong>: print the version after applying that bump to the current project or manual version. <code>NONE</code> leaves the version unchanged.</li>
2114+
<li><strong><code>--tag</code></strong>: print the version formatted with your <code>tag_format</code> (requires <code>--project</code> or <code>--verbose</code>).</li>
2115+
</ul>
2116+
<p><code>--next USE_GIT_COMMITS</code> is reserved for a future feature (derive the bump from git history) and is not implemented yet.</p>
2117+
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h2>
2118+
<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>version<span class="w"> </span>--project
2119+
cz<span class="w"> </span>version<span class="w"> </span><span class="m">2</span>.0.0<span class="w"> </span>--next<span class="w"> </span>MAJOR
2120+
cz<span class="w"> </span>version<span class="w"> </span>--project<span class="w"> </span>--major
2121+
cz<span class="w"> </span>version<span class="w"> </span>--verbose
2122+
</code></pre></div>
20392123

20402124

20412125

@@ -2056,7 +2140,7 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&
20562140
<span class="md-icon" title="Last update">
20572141
<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>
20582142
</span>
2059-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 15, 2025 14:03:19 UTC">May 15, 2025</span>
2143+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 3, 2026 07:01:17 UTC">May 3, 2026</span>
20602144
</span>
20612145

20622146

images/cli_help/cz_version___help.svg

Lines changed: 97 additions & 49 deletions
Loading

images/cli_interactive/bump.gif

282 Bytes
Loading

images/cli_interactive/commit.gif

-1.18 KB
Loading

images/cli_interactive/init.gif

-1.97 KB
Loading
328 Bytes
Loading
-545 Bytes
Loading

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)