---
url: https://relizy.dev/typedoc/type-aliases/CommitlintTitleMode.md
---
[relizy](../index.md) / CommitlintTitleMode

# Type Alias: CommitlintTitleMode

> **CommitlintTitleMode** = `"auto"` | `"error"` | `"warn"` | `"off"`

Defined in: [packages/relizy/src/types.ts:2066](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/types.ts#L2066)

How `relizy commitlint` lints the title of a pull/merge request, which becomes
the commit message of a squash merge:

* `auto`: from the merge method (`mergePreview.squash`, read from the provider
  with a token): a squash merge lints the title as errors and the commits as
  warnings (the merge does not keep them), a merge without squash does not
  lint the title, an unknown method lints it as warnings. On GitHub, the
  squash of a single commit takes its message, not the title: the title is not linted;
* `error`: lints the title, its problems fail the check;
* `warn`: lints the title, its problems never fail the check;
* `off`: does not lint the title.
