thisisnic commented on a change in pull request #12403:
URL: https://github.com/apache/arrow/pull/12403#discussion_r805699233
##########
File path: docs/source/developers/guide/step_by_step/pr_and_github.rst
##########
@@ -127,6 +127,56 @@ If all is set, you can make the pull request!
and other additional information :ref:`pull_request_and_review`
section.
+Continuous Integration (CI)
+---------------------------
+
+Continuous integration (CI) is an automated way to run tests and
+builds on different environments with the changed code made by a
+specific pull request. It serves as a stability check before it
+gets merged or integrated into the main repository of the project.
+
+Once the pull request is created, the CI will trigger checks on the
+code. Depending on what part of the code was changed (documentation,
+C++ or other languages for example) the CI is configured to run
+the relevant checks.
+
+You will see checks running at the bottom of the pull request page
+on GitHub. In case of an error, click on the details and research the cause
+of the failing build.
+
+.. figure:: ci_process_docs.jpeg
+ :scale: 60 %
+ :alt: CI window showing the status of the code checks
+ in case of changes made to the documentation.
+
+ CI checks for changes made to the documentation.
+
+.. figure:: ci_process_python.jpeg
+ :scale: 58 %
+ :alt: CI window showing the status of the code checks
+ in case of changes made to the python files
+
+ CI checks for changes made to the python files.
+
+.. figure:: ci_process_r.jpeg
+ :scale: 58 %
+ :alt: CI window showing the status of the code checks
+ in case of changes made to the R files.
+
+ CI checks for changes made to the R files.
+
+Besides the CI jobs that check the changes in GitHub repository
+(opening or merging of a pull request) we also use CI for nightly
+builds and releases of the Apache Arrow library.
+
+Also, on-demand triggering jobs can be used in your pull
+request for example ``@github-actions crossbow submit python``
+to run PyArrow tests via GitHub actions. These are mostly used to run
+tests on other environments and do not normally need
Review comment:
Nice summary - I'd be a bit more explicit about what kinds of "other"
environments, e.g. "less commonly used" or something.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
