summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-test-submit-rule.txt
blob: ae68b802f8ac58be38ac22d342ca6ba223a2aa0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
gerrit test-submit rule
=======================

NAME
----
gerrit test-submit rule - Test prolog submit rules with a chosen changeset.

SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit test-submit rule'
  [-s]
  [--no-filters]
  CHANGE

DESCRIPTION
-----------
Provides a way to test prolog link:prolog-cookbook.html[submit rules].

OPTIONS
-------
-s::
	Reads a rules.pl file from stdin instead of rules.pl in refs/meta/config.

--no-filters::
	Don't run the submit_filter/2 from the parent projects of the specified change.

ACCESS
------
Can be used by anyone that has permission to read the specified changeset.

EXAMPLES
--------

Test submit_rule from stdin and return the results as JSON.
====
 cat rules.pl | ssh -p 29418 review.example.com gerrit test-submit rule -s I78f2c6673db24e4e92ed32f604c960dc952437d9
 [
   {
     "status": "NOT_READY",
     "reject": {
       "Any-Label-Name": {}
     }
   }
 ]
====

Test the active submit_rule from the refs/meta/config branch, ignoring filters in the project parents.
====
 $ ssh -p 29418 review.example.com gerrit test-submit rule I78f2c6673db24e4e92ed32f604c960dc952437d9 --no-filters
 [
   {
     "status": "NOT_READY",
     "need": {
       "Code-Review": {}
       "Verified": {}
     }
   }
 ]
====

SCRIPTING
---------
Can be used either interactively for testing new prolog submit rules, or from a script to check the submit status of a change.

GERRIT
------
Part of link:index.html[Gerrit Code Review]