Anastasia Klimchuk submitted this change.
doc/dev_guide: Add section about Jenkins build, and scan-build
Change-Id: I416b632c55d1ceb925456ac8c8947dfbcef2e888
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/81261
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
---
M doc/dev_guide/development_guide.rst
1 file changed, 17 insertions(+), 0 deletions(-)
diff --git a/doc/dev_guide/development_guide.rst b/doc/dev_guide/development_guide.rst
index 0b64325..aac3a6c 100644
--- a/doc/dev_guide/development_guide.rst
+++ b/doc/dev_guide/development_guide.rst
@@ -191,6 +191,8 @@
Pushing a patch
---------------
+Before pushing a patch, make sure it builds on your environment and all unit tests pass (see :doc:`building_from_source`).
+
To push patch to Gerrit, use the follow command: :code:`git push upstream HEAD:refs/for/main`.
* If using HTTPS you will be prompted for the username and password you
@@ -209,6 +211,21 @@
Alternatively, you can add a topic from a Gerrit UI after the patch in pushed
(on the top-left section) of patch UI.
+Checking the CI
+---------------
+
+Every patch needs to get a ``Verified +1`` label, typically from Jenkins. Once the patch is pushed
+to Gerrit, Jenkins is added automatically and runs its build script. The script builds the patch with
+various config options, and runs unit tests (for more details see source code of ``test_build.sh``).
+Then, Jenkins gives the patch ``+1`` or ``-1`` vote, indicating success or fail.
+
+In case of failure, follow Jenkins link (which it adds as a comment to the patch), open Console output,
+find the error and try to fix it.
+
+In addition to building and running unit tests, Jenkins also runs a scan-build over the patch. Ideally
+you should check that your patch does not introduce new warnings. To see scan-build report, follow
+Jenkins link -> Build artifacts -> scan build link for the given run.
+
Adding reviewers to the patch
-----------------------------
To view, visit change 81261. To unsubscribe, or for help writing mail filters, visit settings.