You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>The default version provider stores and retrieves the version from your Commitizen configuration file (e.g., <code>pyproject.toml</code>, <code>.cz.toml</code>, etc.).</p>
2340
-
<p><strong>Use when:</strong>
2341
-
- You want to keep version management separate from your package manager
2342
-
- Your project doesn't use a standard package manager
2343
-
- You need maximum flexibility in version management</p>
2340
+
<p><strong>Use when:</strong></p>
2341
+
<ul>
2342
+
<li>You want to keep version management separate from your package manager</li>
2343
+
<li>Your project doesn't use a standard package manager</li>
2344
+
<li>You need maximum flexibility in version management</li>
<spanclass="n">version</span><spanclass="w"></span><spanclass="o">=</span><spanclass="w"></span><spanclass="s2">"0.1.0"</span><spanclass="w"></span><spanclass="c1"># Required when using this provider</span>
<p>Fetches the version from Git tags using <code>git describe</code>. This provider <strong>only reads</strong> version information and never writes it back to files. It's designed to work with tools like <code>setuptools-scm</code> or other package manager <code>*-scm</code> plugins that derive version numbers from Git history.</p>
2351
-
<p><strong>Use when:</strong>
2352
-
- You're using <code>setuptools-scm</code> or similar tools
2353
-
- You want version numbers derived from Git tags
2354
-
- You don't want Commitizen to modify any files for version management</p>
2353
+
<p><strong>Use when:</strong></p>
2354
+
<ul>
2355
+
<li>You're using <code>setuptools-scm</code> or similar tools</li>
2356
+
<li>You want version numbers derived from Git tags</li>
2357
+
<li>You don't want Commitizen to modify any files for version management</li>
<p>Manages version in <code>pyproject.toml</code> under the <code>project.version</code> field, following <ahref="https://peps.python.org/pep-0621/">PEP 621</a> standards.</p>
2366
-
<p><strong>Use when:</strong>
2367
-
- You're using a modern Python project with PEP 621-compliant <code>pyproject.toml</code>
2368
-
- You want version management integrated with your Python project metadata</p>
2370
+
<p><strong>Use when:</strong></p>
2371
+
<ul>
2372
+
<li>You're using a modern Python project with PEP 621-compliant <code>pyproject.toml</code></li>
2373
+
<li>You want version management integrated with your Python project metadata</li>
<p>Manages version in <code>pyproject.toml</code> under the <code>tool.poetry.version</code> field, which is used by the <ahref="https://python-poetry.org/">Poetry</a> package manager. This approach is recommended only for users running Poetry versions earlier than 2.0 or relying on Poetry-specific features. For most users on Poetry 2.0 or later, it is recommended to use <code>pep621</code> instead. <ahref="https://python-poetry.org/docs/main/managing-dependencies/">Read More</a></p>
2380
-
<p><strong>Use when:</strong>
2381
-
- You're using Poetry < 2.0 as your Python package manager
2382
-
- You're using Poetry >= 2.0 as your Python package manager, but don't need poetry-specific features
2383
-
- You want Commitizen to manage the version that Poetry uses</p>
2386
+
<p><strong>Use when:</strong></p>
2387
+
<ul>
2388
+
<li>You're using Poetry < 2.0 as your Python package manager</li>
2389
+
<li>You're using Poetry >= 2.0 as your Python package manager, but don't need poetry-specific features</li>
2390
+
<li>You want Commitizen to manage the version that Poetry uses</li>
@@ -2396,18 +2404,22 @@ <h3 id="uv"><code>uv</code><a class="headerlink" href="#uv" title="Permanent lin
2396
2404
<pclass="admonition-title">Note</p>
2397
2405
<p>Even though uv follows PEP 621 format, <code>pep621</code> does not manage the version in <code>uv.lock</code>. <code>uv</code> is still suggested for uv users.</p>
2398
2406
</div>
2399
-
<p><strong>Use when:</strong>
2400
-
- You're using <code>uv</code> as your Python package manager
2401
-
- You want version synchronization between <code>pyproject.toml</code> and <code>uv.lock</code></p>
2407
+
<p><strong>Use when:</strong></p>
2408
+
<ul>
2409
+
<li>You're using <code>uv</code> as your Python package manager</li>
2410
+
<li>You want version synchronization between <code>pyproject.toml</code> and <code>uv.lock</code></li>
<p>Manages version in both <code>Cargo.toml</code> (<code>package.version</code>) and <code>Cargo.lock</code> (<code>package.version</code> for the matching package name). This ensures consistency between your Rust project's manifest and lock file.</p>
2408
-
<p><strong>Use when:</strong>
2409
-
- You're working with a Rust project using Cargo
2410
-
- You want Commitizen to manage Rust package versions</p>
2418
+
<p><strong>Use when:</strong></p>
2419
+
<ul>
2420
+
<li>You're working with a Rust project using Cargo</li>
2421
+
<li>You want Commitizen to manage Rust package versions</li>
<p>Manages version in <code>package.json</code> and optionally synchronizes with <code>package-lock.json</code> and <code>npm-shrinkwrap.json</code> if they exist.</p>
2422
-
<p><strong>Use when:</strong>
2423
-
- You're working with a Node.js/JavaScript project
2424
-
- You want Commitizen to manage npm package versions</p>
2434
+
<p><strong>Use when:</strong></p>
2435
+
<ul>
2436
+
<li>You're working with a Node.js/JavaScript project</li>
2437
+
<li>You want Commitizen to manage npm package versions</li>
0 commit comments