deploy: 5aa58c6

Author: github-actions[bot]

search/search_index.json

@@ -923,6 +923,39 @@
     <nav class="md-nav" aria-label="Third-Party Commitizen Templates">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#cz-ai" class="md-nav__link">
+    <span class="md-ellipsis">
+      cz-ai
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="cz-ai">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Installation
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#usage" class="md-nav__link">
+    <span class="md-ellipsis">
+      Usage
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#conventional-jira" class="md-nav__link">
     <span class="md-ellipsis">
@@ -934,7 +967,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation" class="md-nav__link">
+  <a href="#installation_1" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -958,7 +991,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_1" class="md-nav__link">
+  <a href="#installation_2" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -982,7 +1015,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_2" class="md-nav__link">
+  <a href="#installation_3" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -991,7 +1024,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage" class="md-nav__link">
+  <a href="#usage_1" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1015,7 +1048,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_3" class="md-nav__link">
+  <a href="#installation_4" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1024,7 +1057,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_1" class="md-nav__link">
+  <a href="#usage_2" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1048,7 +1081,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_4" class="md-nav__link">
+  <a href="#installation_5" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1057,7 +1090,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_2" class="md-nav__link">
+  <a href="#usage_3" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1081,7 +1114,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_5" class="md-nav__link">
+  <a href="#installation_6" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1090,7 +1123,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_3" class="md-nav__link">
+  <a href="#usage_4" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1129,7 +1162,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_6" class="md-nav__link">
+  <a href="#installation_7" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1138,7 +1171,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_4" class="md-nav__link">
+  <a href="#usage_5" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1238,6 +1271,39 @@
     <nav class="md-nav" aria-label="Third-Party Commitizen Templates">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#cz-ai" class="md-nav__link">
+    <span class="md-ellipsis">
+      cz-ai
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="cz-ai">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Installation
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#usage" class="md-nav__link">
+    <span class="md-ellipsis">
+      Usage
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#conventional-jira" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1249,7 +1315,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation" class="md-nav__link">
+  <a href="#installation_1" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1273,7 +1339,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_1" class="md-nav__link">
+  <a href="#installation_2" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1297,7 +1363,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_2" class="md-nav__link">
+  <a href="#installation_3" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1306,7 +1372,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage" class="md-nav__link">
+  <a href="#usage_1" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1330,7 +1396,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_3" class="md-nav__link">
+  <a href="#installation_4" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1339,7 +1405,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_1" class="md-nav__link">
+  <a href="#usage_2" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1363,7 +1429,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_4" class="md-nav__link">
+  <a href="#installation_5" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1372,7 +1438,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_2" class="md-nav__link">
+  <a href="#usage_3" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1396,7 +1462,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_5" class="md-nav__link">
+  <a href="#installation_6" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1405,7 +1471,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_3" class="md-nav__link">
+  <a href="#usage_4" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1444,7 +1510,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#installation_6" class="md-nav__link">
+  <a href="#installation_7" class="md-nav__link">
     <span class="md-ellipsis">
       Installation
     </span>
@@ -1453,7 +1519,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#usage_4" class="md-nav__link">
+  <a href="#usage_5" class="md-nav__link">
     <span class="md-ellipsis">
       Usage
     </span>
@@ -1491,11 +1557,19 @@ <h1>Third-Party Commitizen Templates</h1>
 <h2 id="third-party-commitizen-templates">Third-Party Commitizen Templates<a class="headerlink" href="#third-party-commitizen-templates" title="Permanent link">&para;</a></h2>
 <p>In addition to the native templates, some alternative commit format templates
 are available as PyPI packages (installable with <code>pip</code>).</p>
+<h3 id="cz-ai"><a href="https://github.com/watadarkstar/cz_ai">cz-ai</a><a class="headerlink" href="#cz-ai" title="Permanent link">&para;</a></h3>
+<p>A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.</p>
+<h4 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h4>
+<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>cz-ai
+</code></pre></div>
+<h4 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h4>
+<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--name<span class="w"> </span>cz_ai<span class="w"> </span>commit
+</code></pre></div>
 <h3 id="conventional-jira"><a href="https://pypi.org/project/conventional-JIRA/">Conventional JIRA</a><a class="headerlink" href="#conventional-jira" title="Permanent link">&para;</a></h3>
 <p>Just like <em>conventional commit</em> format, but the scope has been restricted to a
 JIRA issue format, i.e. <code>project-issueNumber</code>. This standardises scopes in a
 meaningful way.</p>
-<h4 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h4>
+<h4 id="installation_1">Installation<a class="headerlink" href="#installation_1" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>conventional-JIRA
 </code></pre></div>
 <h3 id="github-jira-conventional"><a href="https://pypi.org/project/cz-github-jira-conventional/">GitHub JIRA Conventional</a><a class="headerlink" href="#github-jira-conventional" title="Permanent link">&para;</a></h3>
@@ -1505,52 +1579,52 @@ <h3 id="github-jira-conventional"><a href="https://pypi.org/project/cz-github-ji
 <li>creating links to GitHub commits in the CHANGELOG.md</li>
 <li>creating links to JIRA issues in the CHANGELOG.md</li>
 </ul>
-<h4 id="installation_1">Installation<a class="headerlink" href="#installation_1" title="Permanent link">&para;</a></h4>
+<h4 id="installation_2">Installation<a class="headerlink" href="#installation_2" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>cz-github-jira-conventional
 </code></pre></div>
 <p>For installation instructions (configuration and pre-commit) please visit <a href="https://github.com/apheris/cz-github-jira-conventional">https://github.com/apheris/cz-github-jira-conventional</a></p>
 <h3 id="cz-emoji"><a href="https://github.com/adam-grant-hendry/cz-emoji">cz-emoji</a><a class="headerlink" href="#cz-emoji" title="Permanent link">&para;</a></h3>
 <p><em>conventional commit</em> format, but with emojis</p>
-<h4 id="installation_2">Installation<a class="headerlink" href="#installation_2" title="Permanent link">&para;</a></h4>
+<h4 id="installation_3">Installation<a class="headerlink" href="#installation_3" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>cz-emoji
 </code></pre></div>
-<h4 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h4>
+<h4 id="usage_1">Usage<a class="headerlink" href="#usage_1" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--name<span class="w"> </span>cz_emoji<span class="w"> </span>commit
 </code></pre></div>
 <h3 id="cz-conventional-gitmoji"><a href="https://github.com/ljnsn/cz-conventional-gitmoji">cz-conventional-gitmoji</a><a class="headerlink" href="#cz-conventional-gitmoji" title="Permanent link">&para;</a></h3>
 <p><em>conventional commit</em>s, but with <a href="https://gitmoji.dev">gitmojis</a>.</p>
 <p>Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type.</p>
-<h4 id="installation_3">Installation<a class="headerlink" href="#installation_3" title="Permanent link">&para;</a></h4>
+<h4 id="installation_4">Installation<a class="headerlink" href="#installation_4" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>cz-conventional-gitmoji
 </code></pre></div>
-<h4 id="usage_1">Usage<a class="headerlink" href="#usage_1" title="Permanent link">&para;</a></h4>
+<h4 id="usage_2">Usage<a class="headerlink" href="#usage_2" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--name<span class="w"> </span>cz_gitmoji<span class="w"> </span>commit
 </code></pre></div>
 <h3 id="commitizen-emoji-unmaintained"><a href="https://pypi.org/project/commitizen-emoji/">Commitizen emoji</a> (Unmaintained)<a class="headerlink" href="#commitizen-emoji-unmaintained" title="Permanent link">&para;</a></h3>
 <p>Just like <em>conventional commit</em> format, but with emojis and optionally time spent and related tasks.</p>
-<h4 id="installation_4">Installation<a class="headerlink" href="#installation_4" title="Permanent link">&para;</a></h4>
+<h4 id="installation_5">Installation<a class="headerlink" href="#installation_5" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>commitizen-emoji
 </code></pre></div>
-<h4 id="usage_2">Usage<a class="headerlink" href="#usage_2" title="Permanent link">&para;</a></h4>
+<h4 id="usage_3">Usage<a class="headerlink" href="#usage_3" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>cz<span class="w"> </span>--name<span class="w"> </span>cz_commitizen_emoji<span class="w"> </span>commit
 </code></pre></div>
 <h3 id="conventional-legacy-cz_legacy"><a href="https://pypi.org/project/cz_legacy">Conventional Legacy (cz_legacy)</a><a class="headerlink" href="#conventional-legacy-cz_legacy" title="Permanent link">&para;</a></h3>
 <p>An extension of the <em>conventional commit</em> format to include user-specified
 legacy change types in the <code>CHANGELOG</code> while preventing the legacy change types
 from being used in new commit messages</p>
-<h4 id="installation_5">Installation<a class="headerlink" href="#installation_5" title="Permanent link">&para;</a></h4>
+<h4 id="installation_6">Installation<a class="headerlink" href="#installation_6" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>cz_legacy
 </code></pre></div>
-<h4 id="usage_3">Usage<a class="headerlink" href="#usage_3" title="Permanent link">&para;</a></h4>
+<h4 id="usage_4">Usage<a class="headerlink" href="#usage_4" title="Permanent link">&para;</a></h4>
 <p>See the <a href="https://pypi.org/project/cz_legacy">README</a> for instructions on configuration</p>
 <h2 id="third-party-commitizen-providers">Third-Party Commitizen Providers<a class="headerlink" href="#third-party-commitizen-providers" title="Permanent link">&para;</a></h2>
 <p>Commitizen can read and write version from different sources.  In addition to the native providers, some alternative version sources are available as PyPI packages (installable with <code>pip</code>).</p>
 <h3 id="commitizen-deno-provider"><a href="https://pypi.org/project/commitizen-deno-provider/">commitizen-deno-provider</a><a class="headerlink" href="#commitizen-deno-provider" title="Permanent link">&para;</a></h3>
 <p>A provider for <strong>Deno</strong> projects. The provider updates the version in deno.json and jsr.json files.</p>
-<h4 id="installation_6">Installation<a class="headerlink" href="#installation_6" title="Permanent link">&para;</a></h4>
+<h4 id="installation_7">Installation<a class="headerlink" href="#installation_7" title="Permanent link">&para;</a></h4>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>commitizen-deno-provider
 </code></pre></div>
-<h4 id="usage_4">Usage<a class="headerlink" href="#usage_4" title="Permanent link">&para;</a></h4>
+<h4 id="usage_5">Usage<a class="headerlink" href="#usage_5" title="Permanent link">&para;</a></h4>
 <p>Add <code>deno-provider</code> to your configuration file.</p>
 <p>Example for <code>.cz.yaml</code>:</p>
 <div class="highlight"><pre><span></span><code><span class="nn">---</span>