Skip to content

Commit 9bc2996

Browse files
committed
Deploying to gh-pages from @ 1da871e 🚀
1 parent 5f40c15 commit 9bc2996

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

config/configuration_file/index.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2147,14 +2147,16 @@ <h2 id="creating-a-configuration-file">Creating a Configuration File<a class="he
21472147
<p>It is recommended to create a configuration file via our <a href="../../commands/init/"><code>cz init</code></a> command. This command will guide you through setting up your configuration file with the appropriate settings for your project.</p>
21482148
<h2 id="file-location-and-search-order">File Location and Search Order<a class="headerlink" href="#file-location-and-search-order" title="Permanent link">&para;</a></h2>
21492149
<p>Configuration files are typically located in the root of your project directory. Commitizen searches for configuration files in the following order:</p>
2150+
<!-- DEPENDENCY: commitizen/defaults.py CONFIG_FILES -->
2151+
21502152
<ol>
2151-
<li><code>pyproject.toml</code> (in the <code>[tool.commitizen]</code> section)</li>
21522153
<li><code>.cz.toml</code></li>
2154+
<li><code>cz.toml</code></li>
21532155
<li><code>.cz.json</code></li>
21542156
<li><code>cz.json</code></li>
21552157
<li><code>.cz.yaml</code></li>
21562158
<li><code>cz.yaml</code></li>
2157-
<li><code>cz.toml</code></li>
2159+
<li><code>pyproject.toml</code> (in the <code>[tool.commitizen]</code> section)</li>
21582160
</ol>
21592161
<p>The first valid configuration file found will be used. If no configuration file is found, Commitizen will use its default settings.</p>
21602162
<div class="admonition note">
@@ -2166,7 +2168,7 @@ <h2 id="file-location-and-search-order">File Location and Search Order<a class="
21662168
</div>
21672169
<div class="admonition tip">
21682170
<p class="admonition-title">Tip</p>
2169-
<p>For Python projects, it's recommended to add your Commitizen configuration to <code>pyproject.toml</code> to keep all project configuration in one place.</p>
2171+
<p>For Python projects, you can add your Commitizen configuration to <code>pyproject.toml</code> to keep all project configuration in one place.</p>
21702172
</div>
21712173
<div class="admonition warning">
21722174
<p class="admonition-title">Multiple Configuration Files</p>

search/search_index.json

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

0 commit comments

Comments
 (0)