public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Tom Rini <trini@konsulko.com>
To: u-boot@lists.denx.de
Subject: [PATCH] doc: Add basic information about running CI tests
Date: Fri, 18 Dec 2020 17:14:56 -0500	[thread overview]
Message-ID: <20201218221456.14712-1-trini@konsulko.com> (raw)

Start out by documenting general expectations on when CI is run, how
anyone can run Azure pipelines, and how GitLab CI pipelines can be run.

Signed-off-by: Tom Rini <trini@konsulko.com>
---
 doc/develop/ci_testing.rst | 45 ++++++++++++++++++++++++++++++++++++++
 doc/develop/index.rst      |  1 +
 2 files changed, 46 insertions(+)
 create mode 100644 doc/develop/ci_testing.rst

diff --git a/doc/develop/ci_testing.rst b/doc/develop/ci_testing.rst
new file mode 100644
index 000000000000..48dbec4a4452
--- /dev/null
+++ b/doc/develop/ci_testing.rst
@@ -0,0 +1,45 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Continuous Integration testing
+==============================
+
+All changes require passing our continuous integration tests prior to being
+merged in to mainline.  To help facilitate merges being accepted quickly,
+custodians are encouraged but not required to run a pipeline prior to sending a
+pull request.  Individual developers submitting significant or widespread
+changes are encouraged to run a pipeline themselves prior to posting.
+
+In order to make this process as easy as possible, the ability to run a CI
+pipeline is provided in both Azure and GitLab.  Both of these pipelines perform
+their Linux build jobs on the same Docker container image.
+
+Azure Pipelines
+---------------
+
+Currently there are two ways to run a Microsoft Azure Pipeline test for U-Boot.
+The first way is to create an account with Microsoft at
+https://azure.microsoft.com/en-us/services/devops/ and then use the
+``.azure-pipelines.yml`` file in the U-Boot repository as the pipeline
+description.  The second way is to use GitHub and submit a pull request against
+https://github.com/u-boot/u-boot as this will trigger an Azure pipeline run.
+Clicking on your pull request on the list at
+https://github.com/u-boot/u-boot/pulls and then the "Checks" tab will show the
+results.
+
+GitLab CI Pipelines
+-------------------
+
+Currently, we support running GitLab CI pipelines only for custodians, due to
+the resources the project has available.  For Custodians, it is a matter of
+enabling the pipeline feature in your project repository following the standard
+GitLab documentation.  For non-custodians, the pipeline itself is part of the
+tree and should be able to be used on any GitLab instance, with whatever
+runners you are able to provide.
+
+Docker container
+----------------
+
+As previously states, both of the above pipelines build using the same Docker
+container image.  This is maintained in the repository at
+https://gitlab.denx.de/u-boot/gitlab-ci-runner and new images are made as
+needed to support new tests or features.
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 0a7e204b3438..d5619e8fce86 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -7,6 +7,7 @@ Develop U-Boot
 .. toctree::
    :maxdepth: 2
 
+   ci_testing
    coccinelle
    commands
    crash_dumps
-- 
2.17.1

             reply	other threads:[~2020-12-18 22:14 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-18 22:14 Tom Rini [this message]
2020-12-18 23:34 ` [PATCH] doc: Add basic information about running CI tests Sean Anderson
2020-12-19  0:44   ` Tom Rini
2020-12-21  2:17     ` AKASHI Takahiro
2020-12-21 13:42       ` Tom Rini
2020-12-21  2:02 ` AKASHI Takahiro
2021-07-27 17:00 ` [PATCHv2] " Tom Rini
2021-07-27 17:01   ` [PATCH] " Tom Rini
2021-08-05  1:19     ` Tom Rini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201218221456.14712-1-trini@konsulko.com \
    --to=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox