gradle-commitlint/README.MD

Commit-lint plugin for Gradle

Плагин Gradle для проверки описаний коммитов на соответствие соглашению о коммитах.

Использование

Добавить git hook commit-msg:

#!/usr/bin/env sh
./gradlew --console=plain -q commitlint -PgitCommitMessageFile="$1"

Параметр	Описание	По-умолчанию
-PgitCommitMessageFile	Путь до файла сообщения коммита	.git/COMMIT_EDITMSG

Настройка

commitlint {
    types = ["build", "docs", "add", "tweak", "fix", "remove", "revert", "perf", "refac", "style", "test"]
    contexts = ["git", "ide"]
    excludes = ["^wip\$"]
    maxLengthLine = 72
}

Настройка	Описание	По-умолчанию
types	Перечисление допустимых типов коммитов	весь перечень типов из документа соглашения
contexts	Перечисление допустимых контекстов	весь перечень контекстов из документа соглашения
excludes	Перечисление шаблонов для исключений	^wip$
maxLengthLine	Максимальная длинна первой строки коммита	72

Подключение

settings.gradle

pluginManagement {
    repositories {
        gradlePluginPortal()
        maven { url "https://di9.ru/git/api/packages/Conventional-Commits/maven" }
    }
}

build.gradle

plugins {
    id "ru.di9.gradle.commitlint" version "1.1.1"
}