gerrit/Documentation/config-validation.txt
David Pursehouse cde597d4f4 Improve documentation of commit validation
Mention that the plugin can reject commits by throwing an
exception.

Make it clearer that the validation also applies to commits made
within the Gerrit Web UI.

Change-Id: Ibd58aed5cd2a25ebe882020c7a530942c18dd8cd
2013-05-30 14:14:04 +09:00

26 lines
828 B
Plaintext

Gerrit Code Review - Commit Validation
======================================
Gerrit supports link:dev-plugins.html[plugin-based] validation of
commits.
Plugins implementing the `CommitValidationListener` interface can
perform additional validation checks against new commits.
If the commit fails the validation, the plugin can either provide a
message that will be sent back to the git client, or throw an exception
which will cause the commit to be rejected.
Validation applies to both commits uploaded via `git push`, and new
commits generated via Gerrit's Web UI features such as the rebase, revert
and cherry-pick buttons.
Out of the box, Gerrit includes a plugin that checks the length of the
subject and body lines of commit messages on uploaded commits.
GERRIT
------
Part of link:index.html[Gerrit Code Review]