gerrit/Documentation/config-validation.txt
David Pursehouse 8f9e9f58e2 Add merge validation interface
Add a new MergeValidationListener interface which can be used to
provide additional validation of commits before they are merged to
the git repository.

Add a MergeValidators class to invoke the merge validator listeners,
and call it from MergeOp before the commit is merged.

Add a listener to invoke validation provided by plugins.

Change-Id: I325d923f5cc0245b60e86a035329b640c1682d48
2013-08-08 11:32:21 +09:00

43 lines
1.2 KiB
Plaintext

Gerrit Code Review - Commit Validation
======================================
Gerrit supports link:dev-plugins.html[plugin-based] validation of
commits.
[[new-commit-validation]]
New commit validation
---------------------
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.
[[pre-merge-validation]]
Pre-merge validation
--------------------
Plugins implementing the `MergeValidationListener` interface can
perform additional validation checks against commits before they
are merged to the git repository.
If the commit fails the validation, the plugin can throw an exception
which will cause the merge to fail.
GERRIT
------
Part of link:index.html[Gerrit Code Review]