From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-21.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7803BC4338F for ; Tue, 27 Jul 2021 17:01:08 +0000 (UTC) Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 4C19360240 for ; Tue, 27 Jul 2021 17:01:07 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 4C19360240 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=konsulko.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=lists.denx.de Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 9DDA3831BD; Tue, 27 Jul 2021 19:01:05 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Received: by phobos.denx.de (Postfix, from userid 109) id CFE1B831BD; Tue, 27 Jul 2021 19:01:02 +0200 (CEST) Received: from mail-qk1-f181.google.com (mail-qk1-f181.google.com [209.85.222.181]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 31C0B831D6 for ; Tue, 27 Jul 2021 19:00:58 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=tom.rini@gmail.com Received: by mail-qk1-f181.google.com with SMTP id t68so13005141qkf.8 for ; Tue, 27 Jul 2021 10:00:58 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=0yaFLr4IBR6a/D4vEju/gm6UfDJzl6RZgOt3+ifG4NY=; b=RazXoEpCEXQSclrHcgN80Mmq8M/Cxnj72UVbiyPHGuam5FNUn9GUjJfd4EqHeaq6SU cM0xrERqWBQd0DPQg48YbPJZu7IRLcnA4w2fKspz7m+x+PmggFxvKMH5DQ3fsJ+ryf2W CqK2/PxRYRZJFiDFVPggT0hlx20BzyEqHemILoobNk40fWCmmB5BHLs6k2YT8HqbqYi9 mQRA4C0Fc+eBMiEpd+rMRX256F8/qqsZQauAvLTq4teTITKswysxpip6Q6xsB6gKCLRt oPGy0lq4HF/EzbZ9XKxyvH/BDkeMR8XqP2n7yx6TFH8jtcRyBjxqkf0jh0DNvLyMIl50 5flw== X-Gm-Message-State: AOAM533fk/Gj3boaP05YoGQWyru1EOwd4d4GROyitPWrpkZNBRm/bdR2 f3D7ve/RHqZ2dUj46EKAH6BPyO+KT1BB X-Google-Smtp-Source: ABdhPJxvXufQekh11urvF0YdLddlTmazXOk1PuoIbCGuugvP19H6GNaK/IwOsA8rMGjk+uipbICxhg== X-Received: by 2002:a05:620a:4e1:: with SMTP id b1mr23495680qkh.363.1627405256244; Tue, 27 Jul 2021 10:00:56 -0700 (PDT) Received: from bill-the-cat.lan (2603-6081-7b01-cbda-9c07-e31a-fc07-a573.res6.spectrum.com. [2603:6081:7b01:cbda:9c07:e31a:fc07:a573]) by smtp.gmail.com with ESMTPSA id m19sm1592719qtx.84.2021.07.27.10.00.55 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jul 2021 10:00:55 -0700 (PDT) From: Tom Rini To: u-boot@lists.denx.de Subject: [PATCHv2] doc: Add basic information about running CI tests Date: Tue, 27 Jul 2021 13:00:51 -0400 Message-Id: <20210727170051.25396-1-trini@konsulko.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201218221456.14712-1-trini@konsulko.com> References: <20201218221456.14712-1-trini@konsulko.com> X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean 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 --- Changes in v2: - Address some of Akashi-san's feedback --- 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 54e14dd77b5e..3c0f2da44318 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -9,6 +9,7 @@ Implementation .. toctree:: :maxdepth: 1 + ci_testing commands driver-model/index global_data -- 2.17.1