Deploying to gh-pages from @ 4ade721 🚀

Author: bearomorphism

search/search_index.json

@@ -1400,8 +1400,13 @@
 
 
 <h1 id="configuring-commitizen-in-a-monorepo">Configuring Commitizen in a monorepo<a class="headerlink" href="#configuring-commitizen-in-a-monorepo" title="Permanent link">&para;</a></h1>
-<p>This tutorial assumes the monorepo layout is designed with multiple components that can be released independently of each
-other, it also assumes that conventional commits with scopes are in use. Some suggested layouts:</p>
+<p>This tutorial assumes that your monorepo is structured with multiple components that can be released independently of each other.
+It also assumes that you are using conventional commits with scopes.</p>
+<p>Here is a step-by-step example using two libraries, <code>library-b</code> and <code>library-z</code>:</p>
+<ol>
+<li>
+<p><strong>Organize your monorepo</strong></p>
+<p>For example, you might have one of these layouts:</p>
 <div class="highlight"><pre><span></span><code><span class="go">.</span>
 <span class="go">├── library-b</span>
 <span class="go">│   └── .cz.toml</span>
@@ -1414,7 +1419,9 @@ <h1 id="configuring-commitizen-in-a-monorepo">Configuring Commitizen in a monore
 <span class="go">└── library-z</span>
 <span class="go">    └── .cz.toml</span>
 </code></pre></div>
-<p>Sample <code>.cz.toml</code> for each component:</p>
+</li>
+<li>
+<p><strong>Add a Commitizen configuration for each component</strong></p>
 <div class="highlight"><pre><span></span><code><span class="c1"># library-b/.cz.toml</span>
 <span class="k">[tool.commitizen]</span>
 <span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;cz_customize&quot;</span>
@@ -1431,30 +1438,34 @@ <h1 id="configuring-commitizen-in-a-monorepo">Configuring Commitizen in a monore
 <span class="n">ignored_tag_formats</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;${version}-library-*&quot;</span><span class="p">]</span><span class="w"> </span><span class="c1"># Avoid noise from other tags</span>
 <span class="n">update_changelog_on_bump</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span>
 </code></pre></div>
-<p>And finally, to bump each of these:</p>
+</li>
+<li>
+<p><strong>Bump each component independently</strong></p>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--config<span class="w"> </span>library-b/.cz.toml<span class="w"> </span>bump<span class="w"> </span>--yes
 cz<span class="w"> </span>--config<span class="w"> </span>library-z/.cz.toml<span class="w"> </span>bump<span class="w"> </span>--yes
 </code></pre></div>
+</li>
+</ol>
 <h2 id="changelog-per-component">Changelog per component<a class="headerlink" href="#changelog-per-component" title="Permanent link">&para;</a></h2>
-<p>In order to filter the correct commits for each component, you'll have to come up with a strategy.</p>
+<p>To filter the correct commits for each component, you'll need to define a strategy.</p>
 <p>For example:</p>
 <ul>
-<li>Trigger the pipeline based on the changed path, which can have some downsides, as you'll rely on the developer not including files from other files<ul>
-<li><a href="https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore">GitHub actions</a> uses <code>path</code></li>
+<li>Trigger the pipeline based on the changed path. This can have some downsides, as you'll rely on the developer not including files from unrelated components.<ul>
+<li><a href="https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore">GitHub Actions</a> uses <code>path</code></li>
 <li><a href="https://www.jenkins.io/doc/book/pipeline/syntax/#built-in-conditions">Jenkins</a> uses <code>changeset</code></li>
 <li><a href="https://docs.gitlab.com/ee/ci/yaml/#ruleschanges">GitLab</a> uses <code>rules:changes</code></li>
 </ul>
 </li>
-<li>Filter certain pattern of the commit message (recommended)</li>
+<li>Filter commits by a specific pattern in the commit message (recommended)</li>
 </ul>
 <h3 id="example-with-scope-in-conventional-commits">Example with scope in conventional commits<a class="headerlink" href="#example-with-scope-in-conventional-commits" title="Permanent link">&para;</a></h3>
-<p>For this example, to include the message in the changelog, we will require commits to use a specific scope.
-This way, only relevant commits will be included in the appropriate change log for a given component, and any other commit will be ignored.</p>
-<p>Example config and commit for <code>library-b</code>:</p>
+<p>In this example, we want <code>library-b</code>'s changelog to only include commits that use the <code>library-b</code> scope.
+To achieve this, we configure Commitizen to match only commit messages with that scope.</p>
+<p>Here is an example configuration for <code>library-b</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.commitizen.customize]</span>
-<span class="n">changelog_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;^(feat|fix)</span><span class="se">\\</span><span class="s2">(library-b</span><span class="se">\\</span><span class="s2">)(!)?:&quot;</span><span class="w"> </span><span class="c1">#the pattern on types can be a wild card or any types you wish to include</span>
+<span class="n">changelog_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;^(feat|fix)</span><span class="se">\\</span><span class="s2">(library-b</span><span class="se">\\</span><span class="s2">)(!)?:&quot;</span><span class="w"> </span><span class="c1"># the type pattern can be a wildcard or any types you wish to include</span>
 </code></pre></div>
-<p>A commit message looking like this, would be included:</p>
+<p>With this configuration, a commit message like the following would be included in <code>library-b</code>'s changelog:</p>
 <div class="highlight"><pre><span></span><code>fix(library-b): Some awesome message
 </code></pre></div>