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
<h1id="releasing-with-the-scm-version-provider">Releasing with the SCM Version Provider<aclass="headerlink" href="#releasing-with-the-scm-version-provider" title="Permanent link">¶</a></h1>
2135
+
<p>In this tutorial, you will learn how to bump the version using the <code>scp</code> version provider; as you can't use <code>cz bump</code>.</p>
<p>This means <code>cz bump</code> cannot complete its usual job of writing the new version anywhere (see <ahref="#why-cant-i-bump-with-scm">Why can't I bump with SCM?</a> below).</p>
2143
+
<p>This means <code>cz bump</code> cannot complete its usual job of writing the new version anywhere (see <ahref="#why-cant-i-bump-with-scm">Why can't I bump with SCM?</a> below). In the next section, you will learn how to do it anyways.</p>
2143
2144
<h2id="creating-a-new-version-tag-manually">Creating a New Version Tag Manually<aclass="headerlink" href="#creating-a-new-version-tag-manually" title="Permanent link">¶</a></h2>
2144
-
<p>To release a new version without an extra commit, compute the next tag yourself and create it directly:</p>
2145
+
<p>To release a new version without an extra commit and using tags,
2146
+
you can compute the next tag using <code>cz version</code> and then, you can manually create the tag directly.</p>
2147
+
<p>In this example, we create an annotated tag with the changelog as the tag message, using just <code>git</code>.</p>
<p>Wrap this in a CI job to fully automate releases when using the <code>scm</code> provider using <ahref="https://github.com/commitizen-tools/setup-cz">setup-cz</a></p>
2152
2156
</div>
2153
-
<h2id="why-cant-i-bump-with-scm">Why Can't I Bump with SCM?<aclass="headerlink" href="#why-cant-i-bump-with-scm" title="Permanent link">¶</a></h2>
2154
-
<p>When you run <code>cz bump</code>, Commitizen normally creates a new commit that updates the version somewhere,
2155
-
either in <code>.cz.toml</code>, or in <code>pyproject.toml</code> if you're using Python, or <code>Cargo.toml</code> for rust.
2156
-
It may also update <code>version_files</code> and regenerate <code>CHANGELOG.md</code>.</p>
2157
-
<p>Commitizen deliberately bundles a new release into a single commit.
2158
-
This is core to its philosophy: the version should live in the code itself, not only in a Git tag,
2159
-
so anyone can read the current version straight from the source, without needing to inspect the tags.
2160
-
When a Git tag is the sole source of truth, that guarantee disappears,
2161
-
the version becomes metadata layered on top of your history instead of something visible within the code itself.</p>
<h2id="why-cant-i-bump-with-scm">Why Can't I Bump with SCM?<aclass="headerlink" href="#why-cant-i-bump-with-scm" title="Permanent link">¶</a></h2>
2188
+
<p>When you run <code>cz bump</code>, Commitizen normally creates a new commit that updates the version somewhere,
2189
+
either in <code>.cz.toml</code>, or in <code>pyproject.toml</code> if you're using Python, or <code>Cargo.toml</code> for rust.
2190
+
It may also update <code>version_files</code> and regenerate <code>CHANGELOG.md</code>.</p>
2191
+
<p>Commitizen deliberately bundles a new release into a single "release commit".</p>
2192
+
<p>This is core to its philosophy: the version should live in the code itself, not only in a Git tag,
2193
+
so anyone can read the current version straight from the source, without needing to inspect the tags.</p>
2194
+
<p>When a Git tag is the sole source of truth, that guarantee disappears,
2195
+
the version becomes metadata layered on top of your history instead of something visible within the code itself.</p>
0 commit comments