Skip to content

Commit

Permalink
[FAB-7543] Adds info on CI process to the doc
Browse files Browse the repository at this point in the history
[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>
  • Loading branch information
lehors committed Jan 22, 2018
1 parent ce8c0ab commit 5cc0fe1
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 1 deletion.
32 changes: 32 additions & 0 deletions docs/source/Gerrit/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,37 @@ correctly. Always submit the full set of changes via Gerrit.
When a change is included in the set to enable other changes, but it
will not be part of the final set, please let the reviewers know this.

Check that your change request is validated by the CI process
-------------------------------------------------------------

To ensure stability of the code and limit possible regressions, we use
a Continuous Integration (CI) process based on Jenkins which triggers
a build on several platforms and runs tests against every change
request being submitted. It is your responsibility to check that your
CR passes these tests. No CR will ever be merged if it fails the
tests and you shouldn't expect anybody to pay attention to your CRs
until they pass the CI tests.

To check on the status of the CI process, simply look at your CR on
Gerrit, following the URL that was given to you as the result of the
push in the previous step. The History section at the bottom of the
page will display a set of actions taken by "Hyperledger Jobbuilder"
corresponding to the CI process being executed.

Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1
vote* if successful and a *-1 vote* otherwise.

In case of failure, explore the logs linked from the CR History. If
you spot a problem with your CR amend your commit and push it to
update it. The CI process will kick off again.

If you see nothing wrong with your CR it might be that the CI process
simply failed for some reason unrelated to your change. In that case
you may want to restart the CI process by posting a reply to your CR
with the simple content "reverify". Check the `CI management page
<https://github.com/hyperledger/ci-management/blob/master/docs/fabric_ci_process.md>`
for additional information and options on this.


.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
35 changes: 34 additions & 1 deletion docs/source/submit_cr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,38 @@ Once installed and configured, you can submit your change with ``git review``.

$ git review


Check that your change request is validated by the CI process
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To ensure stability of the code and limit possible regressions, we use
a Continuous Integration (CI) process based on Jenkins which triggers
a build on several platforms and runs tests against every change
request being submitted. It is your responsibility to check that your
CR passes these tests. No CR will ever be merged if it fails the
tests and you shouldn't expect anybody to pay attention to your CRs
until they pass the CI tests.

To check on the status of the CI process, simply look at your CR on
Gerrit, following the URL that was given to you as the result of the
push in the previous step. The History section at the bottom of the
page will display a set of actions taken by "Hyperledger Jobbuilder"
corresponding to the CI process being executed.

Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1
vote* if successful and a *-1 vote* otherwise.

In case of failure, explore the logs linked from the CR History. If
you spot a problem with your CR and want to modify it, proceed to the
following section.

If you see nothing wrong with your CR it might be that the CI process
simply failed for some reason unrelated to your change. In that case
you may want to restart the CI process by posting a reply to your CR
with the simple content "reverify". Check the `CI management page
<https://github.com/hyperledger/ci-management/blob/master/docs/fabric_ci_process.md>`
for additional information and options on this.

Modifying your change request
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

0 comments on commit 5cc0fe1

Please sign in to comment.