Deploying to gh-pages from @ 1eb8fff 🚀

Author: bearomorphism

commands/changelog/index.html

@@ -545,10 +545,10 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#constrains" class="md-nav__link">
+  <a href="#constraints" class="md-nav__link">
     <span class="md-ellipsis">
 
-        Constrains
+        Constraints
 
     </span>
   </a>
@@ -2102,10 +2102,10 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#constrains" class="md-nav__link">
+  <a href="#constraints" class="md-nav__link">
     <span class="md-ellipsis">
 
-        Constrains
+        Constraints
 
     </span>
   </a>
@@ -2248,7 +2248,7 @@
   <h1>changelog</h1>
 
 <h2 id="about">About<a class="headerlink" href="#about" title="Permanent link">&para;</a></h2>
-<p>This command will generate a changelog following the committing rules established.</p>
+<p>Generates a changelog following the committing rules established.</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>To create the changelog automatically on bump, add the setting <a href="../../config/bump/#update_changelog_on_bump">update_changelog_on_bump</a></p>
@@ -2262,7 +2262,7 @@ <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
 <div class="highlight"><pre><span></span><code><span class="c1"># Generate full changelog</span>
 cz<span class="w"> </span>changelog
 
-<span class="c1"># or use the alias</span>
+<span class="c1"># Or use the alias</span>
 cz<span class="w"> </span>ch
 
 <span class="c1"># Get the changelog for the given version</span>
@@ -2271,7 +2271,7 @@ <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
 <span class="c1"># Get the changelog for the given version range</span>
 cz<span class="w"> </span>changelog<span class="w"> </span><span class="m">0</span>.3.0..0.4.0<span class="w"> </span>--dry-run
 </code></pre></div>
-<h2 id="constrains">Constrains<a class="headerlink" href="#constrains" title="Permanent link">&para;</a></h2>
+<h2 id="constraints">Constraints<a class="headerlink" href="#constraints" title="Permanent link">&para;</a></h2>
 <p>Changelog generation is constrained only to <strong>markdown</strong> files.</p>
 <h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">&para;</a></h2>
 <p>These are the variables used by the changelog generator.</p>
@@ -2281,11 +2281,10 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 
 <span class="k">-</span><span class="w"> </span><span class="gs">**&lt;scope&gt;**</span>: &lt;message&gt;
 </code></pre></div>
-<p>It will create a full block like above per version found in the tags.
-And it will create a list of the commits found.
-The <code>change_type</code> and the <code>scope</code> are optional, they don't need to be provided,
-but if your regex does, they will be rendered.</p>
-<p>The format followed by the changelog is the one from <a href="https://keepachangelog.com/">keep a changelog</a>
+<p>Creates a full block like above per version found in the tags, and a list of the commits found.
+The <code>change_type</code> and <code>scope</code> are optional and don't need to be provided,
+but if your regex parses them, they will be rendered.</p>
+<p>The format followed by the changelog is from <a href="https://keepachangelog.com/">keep a changelog</a>
 and the following variables are expected:</p>
 <table>
 <thead>
@@ -2303,7 +2302,7 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 </tr>
 <tr>
 <td><code>date</code></td>
-<td>Date in which the tag was created</td>
+<td>Date when the tag was created</td>
 <td><code>tags</code></td>
 </tr>
 <tr>
@@ -2312,7 +2311,7 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 <td><code>commit regex</code></td>
 </tr>
 <tr>
-<td><code>message</code>*</td>
+<td><code>message</code></td>
 <td>Information extracted from the commit message</td>
 <td><code>commit regex</code></td>
 </tr>
@@ -2323,80 +2322,80 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 </tr>
 <tr>
 <td><code>breaking</code></td>
-<td>Whether is a breaking change or not</td>
+<td>Whether it is a breaking change or not</td>
 <td><code>commit regex</code></td>
 </tr>
 </tbody>
 </table>
-<ul>
-<li><strong>required</strong>: is the only one required to be parsed by the regex</li>
-</ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><code>message</code> is the only variable required to be parsed by the regex.</p>
+</div>
 <h2 id="command-line-options">Command line options<a class="headerlink" href="#command-line-options" title="Permanent link">&para;</a></h2>
 <h3 id="-extras"><code>--extras</code><a class="headerlink" href="#-extras" title="Permanent link">&para;</a></h3>
-<p>Provides your own changelog extra variables by using the <code>extras</code> settings or the <code>--extra/-e</code> parameter.</p>
+<p>Provide your own changelog extra variables by using the <code>extras</code> settings or the <code>--extra/-e</code> parameter.</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--extra<span class="w"> </span><span class="nv">key</span><span class="o">=</span>value<span class="w"> </span>-e<span class="w"> </span><span class="nv">short</span><span class="o">=</span><span class="s2">&quot;quoted value&quot;</span>
 </code></pre></div>
 <h3 id="-file-name"><code>--file-name</code><a class="headerlink" href="#-file-name" title="Permanent link">&para;</a></h3>
-<p>This value can be updated in the configuration file with the key <code>changelog_file</code> under <code>tools.commitizen</code></p>
-<p>Specify the name of the output file, remember that changelog only works with Markdown.</p>
+<p>This value can be updated in the configuration file with the key <code>changelog_file</code> under <code>tool.commitizen</code>.</p>
+<p>Specify the name of the output file. Note that changelog generation only works with Markdown files.</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--file-name<span class="o">=</span><span class="s2">&quot;CHANGES.md&quot;</span>
 </code></pre></div>
 <h3 id="-incremental"><code>--incremental</code><a class="headerlink" href="#-incremental" title="Permanent link">&para;</a></h3>
-<p>This flag can be set in the configuration file with the key <code>changelog_incremental</code> under <code>tools.commitizen</code></p>
+<p>This flag can be set in the configuration file with the key <code>changelog_incremental</code> under <code>tool.commitizen</code></p>
 <p>Benefits:</p>
 <ul>
-<li>Build from the latest version found in changelog, this is useful if you have a different changelog and want to use commitizen</li>
+<li>Build from the latest version found in changelog. This is useful if you have an existing changelog and want to use commitizen to extend it.</li>
 <li>Update unreleased area</li>
-<li>Allows users to manually touch the changelog without being rewritten.</li>
+<li>Allows users to manually edit the changelog without it being completely rewritten.</li>
 </ul>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--incremental
 </code></pre></div>
-<div class="highlight"><pre><span></span><code><span class="k">[tools.commitizen]</span>
+<div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="c1"># ...</span>
 <span class="n">changelog_incremental</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
 <h3 id="-start-rev"><code>--start-rev</code><a class="headerlink" href="#-start-rev" title="Permanent link">&para;</a></h3>
-<p>This value can be set in the configuration file with the key <code>changelog_start_rev</code> under <code>tools.commitizen</code></p>
+<p>This value can be set in the configuration file with the key <code>changelog_start_rev</code> under <code>tool.commitizen</code></p>
 <p>Start from a given git rev to generate the changelog. Commits before that rev will not be considered. This is especially useful for long-running projects adopting conventional commits, where old commit messages might fail to be parsed for changelog generation.</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--start-rev<span class="o">=</span><span class="s2">&quot;v0.2.0&quot;</span>
 </code></pre></div>
-<div class="highlight"><pre><span></span><code><span class="k">[tools.commitizen]</span>
+<div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="c1"># ...</span>
 <span class="n">changelog_start_rev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;v0.2.0&quot;</span>
 </code></pre></div>
 <h3 id="-merge-prerelease"><code>--merge-prerelease</code><a class="headerlink" href="#-merge-prerelease" title="Permanent link">&para;</a></h3>
-<p>This flag can be set in the configuration file with the key <code>changelog_merge_prerelease</code> under <code>tools.commitizen</code></p>
-<p>Collects changes from prereleases into the next non-prerelease. This means that if you have a prerelease version, and then a normal release, the changelog will show the prerelease changes as part of the changes of the normal release. If not set, it will include prereleases in the changelog.</p>
+<p>This flag can be set in the configuration file with the key <code>changelog_merge_prerelease</code> under <code>tool.commitizen</code></p>
+<p>Collects changes from prereleases into the next non-prerelease version. If you have a prerelease version followed by a normal release, the changelog will show the prerelease changes as part of the normal release. If not set, prereleases will be included as separate entries in the changelog.</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--merge-prerelease
 </code></pre></div>
-<div class="highlight"><pre><span></span><code><span class="k">[tools.commitizen]</span>
+<div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen]</span>
 <span class="c1"># ...</span>
 <span class="n">changelog_merge_prerelease</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
 <h3 id="-template"><code>--template</code><a class="headerlink" href="#-template" title="Permanent link">&para;</a></h3>
-<p>Provides your own changelog jinja template by using the <code>template</code> settings or the <code>--template</code> parameter.</p>
+<p>Provide your own changelog Jinja template by using the <code>template</code> settings or the <code>--template</code> parameter.</p>
+<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--template<span class="o">=</span><span class="s2">&quot;path/to/template.j2&quot;</span>
+</code></pre></div>
 <h3 id="-unreleased-version"><code>--unreleased-version</code><a class="headerlink" href="#-unreleased-version" title="Permanent link">&para;</a></h3>
-<p>There is usually a chicken and egg situation when automatically
-bumping the version and creating the changelog.
-If you bump the version first, you have no changelog, you have to
-create it later, and it won't be included in
-the release of the created version.</p>
-<p>If you create the changelog before bumping the version, then you
-usually don't have the latest tag, and the <em>Unreleased</em> title appears.</p>
-<p>By introducing <code>--unreleased-version</code> you can prevent this situation.</p>
+<p>There is usually a chicken-and-egg situation when automatically bumping the version and creating the changelog:</p>
+<ul>
+<li>If you bump the version first, you have no changelog yet, and it won't be included in the release of the created version.</li>
+<li>If you create the changelog before bumping the version, you usually don't have the latest tag, and the <em>Unreleased</em> title appears.</li>
+</ul>
+<p>By using <code>--unreleased-version</code>, you can prevent this situation.</p>
 <p>Before bumping you can run:</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>changelog<span class="w"> </span>--unreleased-version<span class="o">=</span><span class="s2">&quot;v1.0.0&quot;</span>
 </code></pre></div>
-<p>Remember to use the tag instead of the raw version number</p>
-<p>For example if the format of your tag includes a <code>v</code> (<code>v1.0.0</code>), then you should use that,
-if your tag is the same as the raw version, then ignore this.</p>
-<p>Alternatively you can directly bump the version and create the changelog by doing</p>
+<p>Remember to use the tag format instead of the raw version number.</p>
+<p>For example, if your tag format includes a <code>v</code> prefix (e.g., <code>v1.0.0</code>), use that format. If your tag is the same as the raw version (e.g., <code>1.0.0</code>), use the raw version.</p>
+<p>Alternatively, you can directly bump the version and create the changelog by running:</p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>bump<span class="w"> </span>--changelog
 </code></pre></div>
 <h2 id="hooks">Hooks<a class="headerlink" href="#hooks" title="Permanent link">&para;</a></h2>
 <p>Supported hook methods:</p>
 <ul>
-<li>Per parsed message: Useful to add links</li>
+<li>Per parsed message: Useful to add links to commits or issues</li>
 <li>End of changelog generation: Useful to send Slack or chat messages, or notify another department</li>
 </ul>
 <p>Read more about hooks in the <a href="../../customization/config_file/">customization page</a></p>
@@ -2420,7 +2419,7 @@ <h2 id="hooks">Hooks<a class="headerlink" href="#hooks" title="Permanent link">&
     <span class="md-icon" title="Last update">
       <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>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="November 19, 2025 09:12:08 UTC">November 19, 2025</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="January 31, 2026 04:05:41 UTC">January 31, 2026</span>
   </span>