Skip to content

Commit 5cc0fe1

Browse files
committed
[FAB-7543] Adds info on CI process to the doc
[ci skip] This change adds a section on the CI process to the 'Submit your first fix' tutorial and the 'Submitting a Change to Gerrit' section informing contributors of the CI process and instructing them to check on the results. Patch-set #2: Small edits Change-Id: Ica6f6a162e819ca59171dbfebc8134c3802f994c Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
1 parent ce8c0ab commit 5cc0fe1

File tree

2 files changed

+66
-1
lines changed

2 files changed

+66
-1
lines changed

docs/source/Gerrit/changes.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,37 @@ correctly. Always submit the full set of changes via Gerrit.
6868
When a change is included in the set to enable other changes, but it
6969
will not be part of the final set, please let the reviewers know this.
7070

71+
Check that your change request is validated by the CI process
72+
-------------------------------------------------------------
73+
74+
To ensure stability of the code and limit possible regressions, we use
75+
a Continuous Integration (CI) process based on Jenkins which triggers
76+
a build on several platforms and runs tests against every change
77+
request being submitted. It is your responsibility to check that your
78+
CR passes these tests. No CR will ever be merged if it fails the
79+
tests and you shouldn't expect anybody to pay attention to your CRs
80+
until they pass the CI tests.
81+
82+
To check on the status of the CI process, simply look at your CR on
83+
Gerrit, following the URL that was given to you as the result of the
84+
push in the previous step. The History section at the bottom of the
85+
page will display a set of actions taken by "Hyperledger Jobbuilder"
86+
corresponding to the CI process being executed.
87+
88+
Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1
89+
vote* if successful and a *-1 vote* otherwise.
90+
91+
In case of failure, explore the logs linked from the CR History. If
92+
you spot a problem with your CR amend your commit and push it to
93+
update it. The CI process will kick off again.
94+
95+
If you see nothing wrong with your CR it might be that the CI process
96+
simply failed for some reason unrelated to your change. In that case
97+
you may want to restart the CI process by posting a reply to your CR
98+
with the simple content "reverify". Check the `CI management page
99+
<https://github.com/hyperledger/ci-management/blob/master/docs/fabric_ci_process.md>`
100+
for additional information and options on this.
101+
102+
71103
.. Licensed under Creative Commons Attribution 4.0 International License
72104
https://creativecommons.org/licenses/by/4.0/

docs/source/submit_cr.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,38 @@ Once installed and configured, you can submit your change with ``git review``.
186186

187187
$ git review
188188

189+
190+
Check that your change request is validated by the CI process
191+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192+
193+
To ensure stability of the code and limit possible regressions, we use
194+
a Continuous Integration (CI) process based on Jenkins which triggers
195+
a build on several platforms and runs tests against every change
196+
request being submitted. It is your responsibility to check that your
197+
CR passes these tests. No CR will ever be merged if it fails the
198+
tests and you shouldn't expect anybody to pay attention to your CRs
199+
until they pass the CI tests.
200+
201+
To check on the status of the CI process, simply look at your CR on
202+
Gerrit, following the URL that was given to you as the result of the
203+
push in the previous step. The History section at the bottom of the
204+
page will display a set of actions taken by "Hyperledger Jobbuilder"
205+
corresponding to the CI process being executed.
206+
207+
Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1
208+
vote* if successful and a *-1 vote* otherwise.
209+
210+
In case of failure, explore the logs linked from the CR History. If
211+
you spot a problem with your CR and want to modify it, proceed to the
212+
following section.
213+
214+
If you see nothing wrong with your CR it might be that the CI process
215+
simply failed for some reason unrelated to your change. In that case
216+
you may want to restart the CI process by posting a reply to your CR
217+
with the simple content "reverify". Check the `CI management page
218+
<https://github.com/hyperledger/ci-management/blob/master/docs/fabric_ci_process.md>`
219+
for additional information and options on this.
220+
189221
Modifying your change request
190222
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191223

@@ -196,7 +228,8 @@ something affecting CI, you can commit revised changes with
196228
197229
git commit --amend
198230
199-
and then repeat the ``git review`` or full syntax as before.
231+
and then repeat the ``git review`` or full syntax as before. Then
232+
check the results of the CI process that gets triggered as a result.
200233

201234
Should you have further questions, please don't hesitate to ask on the mailing
202235
list or rocket chat.

0 commit comments

Comments
 (0)