diff options
author | Joris Roovers <joris.roovers@gmail.com> | 2023-05-10 08:03:37 +0000 |
---|---|---|
committer | Joris Roovers <joris.roovers@gmail.com> | 2023-05-10 08:03:37 +0000 |
commit | 63b8b218a931f375824b08e65b1c7067aafa50b0 (patch) | |
tree | ed5ae1578543d9d59cbf1e2b880d97ab9b20f605 | |
parent | 68303e589f9599a734e5f096166c1f93a005407f (diff) |
Deployed eb8a553 with MkDocs version: 1.4.3
24 files changed, 140 insertions, 140 deletions
diff --git a/ci/index.html b/ci/index.html index 7a397ee..62bd084 100644 --- a/ci/index.html +++ b/ci/index.html @@ -1044,7 +1044,7 @@ -<h1 id="using-gitlint-in-a-ci-environment">Using gitlint in a CI environment</h1> +<h1 id="using-gitlint-in-a-ci-environment">Using gitlint in a CI environment<a class="headerlink" href="#using-gitlint-in-a-ci-environment" title="Permanent link">¶</a></h1> <p>By default, when just running <code>gitlint</code> without additional parameters, gitlint lints the last commit in the current working directory.</p> <p>This makes it easy to use gitlint in a CI environment (Jenkins, TravisCI, Github Actions, pre-commit, CircleCI, Gitlab, etc). diff --git a/commit_hooks/index.html b/commit_hooks/index.html index b19126b..f64b492 100644 --- a/commit_hooks/index.html +++ b/commit_hooks/index.html @@ -1126,7 +1126,7 @@ <h1>Commit hook Setup</h1> -<h2 id="commit-msg-hook">Commit-msg hook</h2> +<h2 id="commit-msg-hook">Commit-msg hook<a class="headerlink" href="#commit-msg-hook" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.4.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.4.0</a></p> <p>You can install gitlint as a git <code>commit-msg</code> hook so that gitlint checks your commit messages automatically after each commit.</p> @@ -1143,7 +1143,7 @@ uninstall unmodified commit-msg hooks that were installed by gitlint. If you're looking to use gitlint in conjunction with other hooks, you should consider <a href="#pre-commit">using gitlint with pre-commit</a>.</p> </div> -<h2 id="pre-commit">Pre-commit</h2> +<h2 id="pre-commit">Pre-commit<a class="headerlink" href="#pre-commit" title="Permanent link">¶</a></h2> <p><code>gitlint</code> can be configured as a plugin for the <a href="https://pre-commit.com">pre-commit</a> git hooks framework. Simply add the following configuration to your <code>.pre-commit-config.yaml</code>:</p> <div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/jorisroovers/gitlint</span> @@ -1174,7 +1174,7 @@ or modify the gitlint invocation in your <code>.pre-commit-config.yaml</code> fi <p class="admonition-title">Important</p> <p>You need to add <code>--msg-filename</code> at the end of your custom <code>args</code> list as the gitlint-hook will fail otherwise.</p> </div> -<h3 id="gitlint-and-pre-commit-in-ci">gitlint and pre-commit in CI</h3> +<h3 id="gitlint-and-pre-commit-in-ci">gitlint and pre-commit in CI<a class="headerlink" href="#gitlint-and-pre-commit-in-ci" title="Permanent link">¶</a></h3> <p>gitlint also supports a <code>gitlint-ci</code> pre-commit hook that can be used in CI environments.</p> <p>Configure it like so: <div class="language-yaml highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/jorisroovers/gitlint</span> diff --git a/configuration/cli/index.html b/configuration/cli/index.html index 37889dc..0f000ed 100644 --- a/configuration/cli/index.html +++ b/configuration/cli/index.html @@ -1042,7 +1042,7 @@ -<h1 id="commandline-config">Commandline config</h1> +<h1 id="commandline-config">Commandline config<a class="headerlink" href="#commandline-config" title="Permanent link">¶</a></h1> <p>Gitlint behavior can be changed by various commandline flags and environment variables.</p> <p>These fall in 2 categories:</p> <ol> @@ -1077,7 +1077,7 @@ variables available. Example:</p> <p>The benefit of the <code>-c</code> flag is that it can set both <code>general</code> options as well as <code>rule</code> options.</p> <p>The generic config flag format is <code>-c <rule>.<option>=<value></code> and supports all the same rules and options which you can also use in a <a href="../gitlint_file/"><code>.gitlint</code> config file</a>.</p> -<h1 id="all-commands-and-options">All commands and options</h1> +<h1 id="all-commands-and-options">All commands and options<a class="headerlink" href="#all-commands-and-options" title="Permanent link">¶</a></h1> <div class="language-text highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>$ gitlint --help </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>Usage: gitlint [OPTIONS] COMMAND [ARGS]... </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> diff --git a/configuration/general_options/index.html b/configuration/general_options/index.html index 6e4b58a..68fde16 100644 --- a/configuration/general_options/index.html +++ b/configuration/general_options/index.html @@ -1351,7 +1351,7 @@ <h1>General Options</h1> <p>Gitlint has a number of options that modify it's overall behavior, documented below.</p> -<h2 id="silent">silent</h2> +<h2 id="silent">silent<a class="headerlink" href="#silent" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.1.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.1.0</a></p> <p>Enable silent mode (no output).</p> <table> @@ -1384,7 +1384,7 @@ </div> </div> </div> -<h2 id="verbosity">verbosity</h2> +<h2 id="verbosity">verbosity<a class="headerlink" href="#verbosity" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.1.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.1.0</a></p> <p>Amount of output gitlint will show when printing errors.</p> <table> @@ -1428,7 +1428,7 @@ </div> </div> </div> -<h2 id="ignore">ignore</h2> +<h2 id="ignore">ignore<a class="headerlink" href="#ignore" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.1.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.1.0</a></p> <p>Comma separated list of rules to ignore (by name or id).</p> <table> @@ -1468,7 +1468,7 @@ </div> </div> </div> -<h2 id="debug">debug</h2> +<h2 id="debug">debug<a class="headerlink" href="#debug" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.7.1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.7.1</a></p> <p>Enable debugging output.</p> <table> @@ -1503,7 +1503,7 @@ </div> </div> </div> -<h2 id="target">target</h2> +<h2 id="target">target<a class="headerlink" href="#target" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.8.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.8.0</a></p> <p>Target git repository gitlint should be linting against.</p> <table> @@ -1542,7 +1542,7 @@ </div> </div> </div> -<h2 id="commit">commit</h2> +<h2 id="commit">commit<a class="headerlink" href="#commit" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.16.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.16.0</a></p> <p>Git reference of specific commit to lint.</p> <table> @@ -1581,7 +1581,7 @@ </div> </div> </div> -<h2 id="commits">commits</h2> +<h2 id="commits">commits<a class="headerlink" href="#commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.8.1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.8.1</a></p> <p>Range of commits (refspec or comma-separated hashes) to lint.</p> <table> @@ -1642,7 +1642,7 @@ </div> </div> </div> -<h2 id="config">config</h2> +<h2 id="config">config<a class="headerlink" href="#config" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.1.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.1.0</a></p> <p>Path where gitlint looks for a config file.</p> <table> @@ -1676,7 +1676,7 @@ </div> </div> </div> -<h2 id="extra-path">extra-path</h2> +<h2 id="extra-path">extra-path<a class="headerlink" href="#extra-path" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.8.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.8.0</a></p> <p>Path where gitlint looks for <a href="../../rules/user_defined_rules/getting_started/">user-defined rules</a>.</p> <table> @@ -1744,7 +1744,7 @@ </div> </div> </div> -<h2 id="contrib">contrib</h2> +<h2 id="contrib">contrib<a class="headerlink" href="#contrib" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.12.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.12.0</a></p> <p>Comma-separated list of <a href="../../rules/contrib_rules/">Contrib rules</a> to enable (by name or id).</p> <table> @@ -1784,7 +1784,7 @@ </div> </div> </div> -<h2 id="msg-filename">msg-filename</h2> +<h2 id="msg-filename">msg-filename<a class="headerlink" href="#msg-filename" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.8.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.8.0</a></p> <p>Path to a file containing the commit-msg to be linted.</p> <table> @@ -1813,7 +1813,7 @@ </div> </div> </div> -<h2 id="staged">staged</h2> +<h2 id="staged">staged<a class="headerlink" href="#staged" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.13.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.13.0</a></p> <p>Attempt smart guesses about meta info (like author name, email, branch, changed files, etc) when manually passing a commit message to gitlint via stdin or <code>--commit-msg</code>.</p> @@ -1859,7 +1859,7 @@ access to the commit message itself for linting and won't be able to enforce rul </div> </div> </div> -<h2 id="fail-without-commits">fail-without-commits</h2> +<h2 id="fail-without-commits">fail-without-commits<a class="headerlink" href="#fail-without-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.16.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.16.0</a></p> <p>Hard fail when the target commit range is empty. Note that gitlint will already fail by default on invalid commit ranges. This option is specifically @@ -1901,7 +1901,7 @@ to tell gitlint to fail on <strong>valid but empty</strong> commit ranges.</p> </div> </div> </div> -<h2 id="regex-style-search">regex-style-search</h2> +<h2 id="regex-style-search">regex-style-search<a class="headerlink" href="#regex-style-search" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.18.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.18.0</a></p> <p>Whether to use Python <code>re.search()</code> instead of <code>re.match()</code> semantics in all built-in rules that use regular expressions. </p> <details> @@ -1970,7 +1970,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </li> </ol> -<h2 id="ignore-stdin">ignore-stdin</h2> +<h2 id="ignore-stdin">ignore-stdin<a class="headerlink" href="#ignore-stdin" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.12.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.12.0</a></p> <p>Ignore any stdin data.</p> <table> @@ -2009,7 +2009,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </div> </div> -<h2 id="ignore-merge-commits">ignore-merge-commits</h2> +<h2 id="ignore-merge-commits">ignore-merge-commits<a class="headerlink" href="#ignore-merge-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.7.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.7.0</a></p> <p>Whether or not to ignore merge commits.</p> <table> @@ -2043,7 +2043,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </div> </div> -<h2 id="ignore-revert-commits">ignore-revert-commits</h2> +<h2 id="ignore-revert-commits">ignore-revert-commits<a class="headerlink" href="#ignore-revert-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.13.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.13.0</a></p> <p>Whether or not to ignore revert commits.</p> <table> @@ -2077,7 +2077,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </div> </div> -<h2 id="ignore-fixup-commits">ignore-fixup-commits</h2> +<h2 id="ignore-fixup-commits">ignore-fixup-commits<a class="headerlink" href="#ignore-fixup-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.9.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.9.0</a></p> <p>Whether or not to ignore <a href="https://git-scm.com/docs/git-commit#git-commit---fixupltcommitgt">fixup</a> commits.</p> <table> @@ -2111,7 +2111,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </div> </div> -<h2 id="ignore-fixup-amend-commits">ignore-fixup-amend-commits</h2> +<h2 id="ignore-fixup-amend-commits">ignore-fixup-amend-commits<a class="headerlink" href="#ignore-fixup-amend-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.18.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.18.0</a></p> <p>Whether or not to ignore <a href="https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt">fixup=amend</a> commits.</p> <table> @@ -2145,7 +2145,7 @@ use <code>re.search()</code> instead of <code>re.match()</code>. For detailed co </div> </div> </div> -<h2 id="ignore-squash-commits">ignore-squash-commits</h2> +<h2 id="ignore-squash-commits">ignore-squash-commits<a class="headerlink" href="#ignore-squash-commits" title="Permanent link">¶</a></h2> <p><a href="https://github.com/jorisroovers/gitlint/releases/tag/v0.9.0"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.75 6.5a1.25 1.25 0 1 0 0 2.5 1.25 1.25 0 0 0 0-2.5Z"/><path d="M2.5 1h8.44a1.5 1.5 0 0 1 1.06.44l10.25 10.25a1.5 1.5 0 0 1 0 2.12l-8.44 8.44a1.5 1.5 0 0 1-2.12 0L1.44 12A1.497 1.497 0 0 1 1 10.94V2.5A1.5 1.5 0 0 1 2.5 1Zm0 1.5v8.44l10.25 10.25 8.44-8.44L10.94 2.5Z"/></svg></span> v0.9.0</a></p> <p>Whether or not to ignore <a href="https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---squashltcommitgt">squash</a> commits.</p> <table> diff --git a/configuration/gitlint_file/index.html b/configuration/gitlint_file/index.html index 04671be..326d310 100644 --- a/configuration/gitlint_file/index.html +++ b/configuration/gitlint_file/index.html @@ -1042,7 +1042,7 @@ -<h1 id="the-gitlint-file">The .gitlint file</h1> +<h1 id="the-gitlint-file">The .gitlint file<a class="headerlink" href="#the-gitlint-file" title="Permanent link">¶</a></h1> <p>You can modify gitlint's behavior by adding a <code>.gitlint</code> file to your git repository.</p> <p>Generate a default <code>.gitlint</code> config file by running: <div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>gitlint<span class="w"> </span>generate-config @@ -1050,7 +1050,7 @@ You can also use a different config file like so:</p> <div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>gitlint<span class="w"> </span>--config<span class="w"> </span>myconfigfile.ini </span></code></pre></div> -<h1 id="example-gitlint">Example <code>.gitlint</code></h1> +<h1 id="example-gitlint">Example <code>.gitlint</code><a class="headerlink" href="#example-gitlint" title="Permanent link">¶</a></h1> <div class="language-ini copy highlight"><span class="filename">.gitlint</span><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1">### GENERAL CONFIG ### (1)</span> </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="k">[general]</span> </span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="c1"># Ignore rules, reference them by id or name (comma-separated)</span> diff --git a/configuration/index.html b/configuration/index.html index 3fba527..25ca74d 100644 --- a/configuration/index.html +++ b/configuration/index.html @@ -1102,7 +1102,7 @@ -<h1 id="configuration">Configuration</h1> +<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h1> <p>Gitlint provides multiple ways to configure its behavior:</p> <ol> <li><strong><a href="gitlint_file/"><code>.gitlint</code> file</a></strong> (Recommended)</li> @@ -1110,7 +1110,7 @@ <li><strong><a href="commit_config/">Config in your commit message</a></strong></li> <li><strong><a href="../rules/user_defined_rules/configuration_rules/">Configuration Rules</a></strong></li> </ol> -<h2 id="quick-start">Quick start</h2> +<h2 id="quick-start">Quick start<a class="headerlink" href="#quick-start" title="Permanent link">¶</a></h2> <div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> .gitlint</label><label for="__tabbed_1_2"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M0 2.75C0 1.784.784 1 1.75 1h12.5c.966 0 1.75.784 1.75 1.75v10.5A1.75 1.75 0 0 1 14.25 15H1.75A1.75 1.75 0 0 1 0 13.25Zm1.75-.25a.25.25 0 0 0-.25.25v10.5c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25V2.75a.25.25 0 0 0-.25-.25ZM7.25 8a.749.749 0 0 1-.22.53l-2.25 2.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L5.44 8 3.72 6.28a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215l2.25 2.25c.141.14.22.331.22.53Zm1.5 1.5h3a.75.75 0 0 1 0 1.5h-3a.75.75 0 0 1 0-1.5Z"/></svg></span> CLI</label><label for="__tabbed_1_3"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 2H3c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h18c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2m0 18H3V6h18v14M16.6 8c1.5 1.3 2.4 3.1 2.4 5s-.9 3.7-2.4 5l-1.6-.6c1.3-1 2-2.7 2-4.4s-.7-3.4-2-4.4l1.6-.6M7.4 8l1.6.6c-1.3 1-2 2.7-2 4.4s.7 3.4 2 4.4l-1.6.6C5.9 16.7 5 14.9 5 13s.9-3.7 2.4-5m4.7 4 1.4-2H15l-2.2 3 1.3 3h-1.3l-.8-2-1.4 2H9l2.3-3.1L10 10h1.3l.8 2Z"/></svg></span> Env var</label></div> <div class="tabbed-content"> <div class="tabbed-block"> @@ -1167,7 +1167,7 @@ </div> </div> </div> -<h2 id="configuration-precedence">Configuration precedence</h2> +<h2 id="configuration-precedence">Configuration precedence<a class="headerlink" href="#configuration-precedence" title="Permanent link">¶</a></h2> <p>Gitlint configuration is applied in the following order of precedence:</p> <ol> <li>Commit specific config (e.g.: <code>gitlint-ignore: all</code> in the commit message)</li> diff --git a/contributing/contrib_rules/index.html b/contributing/contrib_rules/index.html index cc328c0..4e6165a 100644 --- a/contributing/contrib_rules/index.html +++ b/contributing/contrib_rules/index.html @@ -1095,7 +1095,7 @@ Then, we suggest taking the following approach to add a Contrib rule:</p> <li><strong>Write documentation</strong>. In particular, you should update the <a href="https://github.com/jorisroovers/gitlint/blob/main/docs/contributing/contrib_rules.md">gitlint/docs/contributing/contrib_rules.md</a> file with details on your Contrib rule.</li> <li><strong>Create a Pull Request</strong>: code review typically requires a bit of back and forth. Thanks for your contribution!</li> </ol> -<h2 id="contrib-rule-requirements">Contrib rule requirements</h2> +<h2 id="contrib-rule-requirements">Contrib rule requirements<a class="headerlink" href="#contrib-rule-requirements" title="Permanent link">¶</a></h2> <p>If you follow the steps above and follow the existing gitlint conventions wrt naming things, you should already be fairly close to done.</p> <p>In case you're looking for a slightly more formal spec, here's what gitlint requires of Contrib rules.</p> <ul> diff --git a/contributing/environment_setup/index.html b/contributing/environment_setup/index.html index b9753a7..2f025ac 100644 --- a/contributing/environment_setup/index.html +++ b/contributing/environment_setup/index.html @@ -1138,10 +1138,10 @@ <h1>Environment Setup</h1> -<h2 id="hatch">Hatch</h2> +<h2 id="hatch">Hatch<a class="headerlink" href="#hatch" title="Permanent link">¶</a></h2> <p>Gitlint uses <a href="https://hatch.pypa.io/latest/">hatch</a> for project management, including package building, environment management and script/test running.</p> -<h2 id="local-setup">Local setup</h2> +<h2 id="local-setup">Local setup<a class="headerlink" href="#local-setup" title="Permanent link">¶</a></h2> <div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Clone gitlint repo</span> </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/jorisroovers/gitlint </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="nb">cd</span><span class="w"> </span>gitlint @@ -1162,7 +1162,7 @@ environment management and script/test running.</p> <li>Hatch will automatically setup a <code>test</code> environment for you the first time you run this command. <br/><br/> See <a href="../tests_formatting_docs/">Tests, Formatting, Docs</a> for more test commands.</li> </ol> -<h2 id="github-codespace">Github Codespace</h2> +<h2 id="github-codespace">Github Codespace<a class="headerlink" href="#github-codespace" title="Permanent link">¶</a></h2> <p>We provide a devcontainer to use with github codespaces to make it easier to get started with gitlint development using VSCode.</p> <p>To start one, click the plus button under the <em>Code</em> dropdown on @@ -1181,7 +1181,7 @@ using VSCode.</p> <li>Hatch will automatically setup a <code>test</code> environment for you the first time you run this command. <br/><br/> See <a href="../tests_formatting_docs/">Tests, Formatting, Docs</a> for more test commands.</li> </ol> -<h3 id="installing-additional-python-versions">Installing additional python versions</h3> +<h3 id="installing-additional-python-versions">Installing additional python versions<a class="headerlink" href="#installing-additional-python-versions" title="Permanent link">¶</a></h3> <p>By default we have python 3.11 installed in the dev container, but you can also use <a href="https://asdf-vm.com/">asdf</a> (preinstalled) to install additional python versions:</p> <div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Ensure ASDF overrides system python in PATH</span> diff --git a/contributing/index.html b/contributing/index.html index 6e1d048..de8069e 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -1088,7 +1088,7 @@ -<h1 id="contributing">Contributing</h1> +<h1 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">¶</a></h1> <p>We'd love for you to contribute to gitlint. Thanks for your interest! The <a href="https://github.com/jorisroovers/gitlint">source-code and issue tracker</a> are hosted on Github.</p> <div class="admonition note"> @@ -1099,7 +1099,7 @@ your interest! We maintain a <a href="https://github.com/users/jorisroovers/projects/1/">loose project plan on github projects</a>, but that's open to a lot of change and input.</p> </div> -<h2 id="overall-guidelines">Overall Guidelines</h2> +<h2 id="overall-guidelines">Overall Guidelines< |