{
    "componentChunkName": "component---src-templates-plugin-docs-tsx",
    "path": "/plugins/scm-commit-message-checker-plugin/docs/3.1.x/en/configuration/",
    "result": {"data":{"plugin":{"name":"scm-commit-message-checker-plugin","displayName":"Commit Message Checker","description":"Validates commit message on each commit for pattern or format","author":"Cloudogu GmbH","documentation":[{"version":"3.1.x","languages":["de","en"]},{"version":"3.0.x","languages":["de","en"]},{"version":"1.5.x","languages":["de","en"]},{"version":"1.4.x","languages":["de","en"]},{"version":"1.3.x","languages":["de","en"]},{"version":"1.2.x","languages":["de","en"]},{"version":"1.1.x","languages":["de","en"]},{"version":"1.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"First steps","entries":[{"frontmatter":{"title":"Configuration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-commit-message-checker-plugin/docs/3.1.x/en/configuration/"}},{"frontmatter":{"title":"Permissions","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-commit-message-checker-plugin/docs/3.1.x/en/permissions/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"1.1.x"},{"fieldValue":"1.2.x"},{"fieldValue":"1.3.x"},{"fieldValue":"1.4.x"},{"fieldValue":"1.5.x"},{"fieldValue":"3.0.x"},{"fieldValue":"3.1.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"<p>The SCM-Commit-Message-Checker-Plugin can be configured globally and repository specific. The global configuration is used for all repositories which doesn't have a specific config. The repository specific configuration can be disabled in the global config.</p>\n<h3 id=\"configuration-form\" style=\"position:relative;\"><a href=\"#configuration-form\" aria-label=\"configuration form permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Configuration form</h3>\n<p>To validate your commit messages you can use the provided configurable validators. Other SCM-Manager plugins may provide their own validators which can be used in this configuration.\nThis plugin only has one validator which can be applied multiple times.</p>\n<h3 id=\"custom-regex-validator\" style=\"position:relative;\"><a href=\"#custom-regex-validator\" aria-label=\"custom regex validator permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Custom RegEx Validator</h3>\n<p>The \"Custom Regular Expression Validator\" can validate commit messages using your own regular expression.\nBesides the pattern you can also set which branches should be validated and what error message will be shown on invalid commit messages.</p>\n<p>The validator will check, if the pattern matches any part of the message. So if you want the whole message to be checked,\nyou have to enclose the pattern with <code class=\"language-text\">^</code> and <code class=\"language-text\">$</code> like <code class=\"language-text\">^[A-Za-z0-9 ]*$</code>.</p>\n<p>Here are some examples:</p>\n<table>\n<thead>\n<tr>\n<th>Expression</th>\n<th>Check</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">^[A-Za-z0-9 ]*$</code></td>\n<td>The complete message must only contain letters, numbers and spaces</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">#[0-9]+</code></td>\n<td>The message has to contain a number with a leading hash like <code class=\"language-text\">#42</code></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">.{10}</code></td>\n<td>The message has to have at least 10 characters</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">fixed|updated|added</code></td>\n<td>The message has to contain one of the words <code class=\"language-text\">fixed</code>, <code class=\"language-text\">updated</code>, or <code class=\"language-text\">added</code></td>\n</tr>\n</tbody>\n</table>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 590px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 70.94594594594594%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAOCAYAAAAvxDzwAAAACXBIWXMAAAsTAAALEwEAmpwYAAABqElEQVQ4y5WTTW/UMBCG8//vlThRJA5cOHDqlR+BhCoQAvVA1cZ24vhj/DV+kWd36e7CtmDpzciO89gz82biVrFZC2st1nWV2JgxRu/9rwJ2sZ1prE29ZpB3iJEQQoAPAaXtgIexg1yeH49pPFZrUUqRBWaWm444Dhg3HsM5B2MMeA9LrePDHeH9j4h33wLefPW48xUTeseyLFBKYZ5nEJEAvfcCHJAYowDHvvEuUYTZPN7eGrz+bHD9xeHVrcN3VzG11mAEqOEpgfvl2p3UsXcUt6J6e5rySGFzHtosWDaH3BidWVK+JGlIa7tS1SaXaLxvytjw8/4eD48ztNaS9jwrzEpBaS1NOtahcSklWB+QSz1xhAD1ssLFhJQLKGekF0QpI5UKEzIc5T+Bs9ZymgBTflGREkqtCN5L/VnSxRNQaYNHpeWW8sEzGhmMmHNBYcDVjq0w/JgcgC5EuFEfSs/ChnyMWEME7X2LI5N36TIzEpH4TxQjiM4kayR+XIa51wVoTQDnVpr+xXNP/zBAveNKbfjo4kkzfvvwf4GZO25swKez7h6AvwC5+kQNJAaOhQAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Commit Message Validation configuration\"\n        title=\"Commit Message Validation configuration\"\n        src=\"/static/242d0538cfcffa4e800949a50c4957c2/fcda8/config.png\"\n        srcset=\"/static/242d0538cfcffa4e800949a50c4957c2/12f09/config.png 148w,\n/static/242d0538cfcffa4e800949a50c4957c2/e4a3f/config.png 295w,\n/static/242d0538cfcffa4e800949a50c4957c2/fcda8/config.png 590w,\n/static/242d0538cfcffa4e800949a50c4957c2/efc66/config.png 885w,\n/static/242d0538cfcffa4e800949a50c4957c2/c83ae/config.png 1180w,\n/static/242d0538cfcffa4e800949a50c4957c2/27e9a/config.png 1253w\"\n        sizes=\"(max-width: 590px) 100vw, 590px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n    </span></p>","description":"The SCM-Commit-Message-Checker-Plugin can be configured globally and repository specific. The global configuration is used for all repositories which doesn't…","tableOfContents":"<ul>\n<li><a href=\"#configuration-form\">Configuration form</a></li>\n<li><a href=\"#custom-regex-validator\">Custom RegEx Validator</a></li>\n</ul>","frontmatter":{"title":"Configuration","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-commit-message-checker-plugin","slug":"/plugins/scm-commit-message-checker-plugin/docs/3.1.x/en/configuration/","version":"3.1.x","latestVersion":"3.1.x","latestPageVersion":"3.1.x","language":"en","canonicalPath":"/plugins/scm-commit-message-checker-plugin/docs/latest/en/configuration/","latestRootPath":"/plugins/scm-commit-message-checker-plugin/docs/3.1.x/en/"}},
    "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}