blob: ae68b802f8ac58be38ac22d342ca6ba223a2aa0f [file] [log] [blame]
Shawn Pearceb1f730b2013-03-04 07:54:09 -08001gerrit test-submit rule
Johan Björk20ae0692012-08-02 15:57:13 +02002=======================
3
4NAME
5----
Shawn Pearceb1f730b2013-03-04 07:54:09 -08006gerrit test-submit rule - Test prolog submit rules with a chosen changeset.
Johan Björk20ae0692012-08-02 15:57:13 +02007
8SYNOPSIS
9--------
10[verse]
Shawn Pearceb1f730b2013-03-04 07:54:09 -080011'ssh' -p <port> <host> 'gerrit test-submit rule'
Johan Björk20ae0692012-08-02 15:57:13 +020012 [-s]
13 [--no-filters]
Johan Björk20ae0692012-08-02 15:57:13 +020014 CHANGE
15
16DESCRIPTION
17-----------
18Provides a way to test prolog link:prolog-cookbook.html[submit rules].
19
20OPTIONS
21-------
22-s::
23Reads a rules.pl file from stdin instead of rules.pl in refs/meta/config.
24
25--no-filters::
26Don't run the submit_filter/2 from the parent projects of the specified change.
27
Johan Björk20ae0692012-08-02 15:57:13 +020028ACCESS
29------
30Can be used by anyone that has permission to read the specified changeset.
31
32EXAMPLES
33--------
34
Johan Björk20ae0692012-08-02 15:57:13 +020035Test submit_rule from stdin and return the results as JSON.
36====
Shawn Pearceb1f730b2013-03-04 07:54:09 -080037 cat rules.pl | ssh -p 29418 review.example.com gerrit test-submit rule -s I78f2c6673db24e4e92ed32f604c960dc952437d9
38 [
39 {
40 "status": "NOT_READY",
41 "reject": {
42 "Any-Label-Name": {}
43 }
44 }
45 ]
Johan Björk20ae0692012-08-02 15:57:13 +020046====
47
48Test the active submit_rule from the refs/meta/config branch, ignoring filters in the project parents.
49====
Shawn Pearceb1f730b2013-03-04 07:54:09 -080050 $ ssh -p 29418 review.example.com gerrit test-submit rule I78f2c6673db24e4e92ed32f604c960dc952437d9 --no-filters
51 [
52 {
53 "status": "NOT_READY",
54 "need": {
55 "Code-Review": {}
56 "Verified": {}
57 }
58 }
59 ]
Johan Björk20ae0692012-08-02 15:57:13 +020060====
61
62SCRIPTING
63---------
64Can be used either interactively for testing new prolog submit rules, or from a script to check the submit status of a change.
65
66GERRIT
67------
68Part of link:index.html[Gerrit Code Review]