From nobody Sun Feb 8 21:47:43 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+96973+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+96973+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=linux.microsoft.com ARC-Seal: i=1; a=rsa-sha256; t=1670261355; cv=none; d=zohomail.com; s=zohoarc; b=RCR8MDFtggkVIzuyi83duExnT38CmO6UacN4tlwXDxJXKmKOyIVA+T5X70LHv6as5UbMWWf9M92JnMgIxb4f47wYi9CrRv5xYroTJ5y5tSf06X714uIKa0VSblvWwiHKXr4+96RSWb3LPrxEuXAuZKcgvG1WUgWv0pbx9FW7GFw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1670261355; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=LtMOZJYzAOS2j1sJfASo7RLr5c9MVozW2f8pfV/EnDA=; b=hwjtjI+FU1xPkR4aV2wg3Ob09V9jjHY6ocOPCcqp2gw2i8/NExW0HI77A3OwnCytnjAGYfUAFSH/QN3TjNlaC8yncJ2u02VYWfksKhQ5PAKOe8Xk6IJGRpxO0F3eVfOoHrQzhjf+wG8R6XkSAtON8QeQ4dCcRBMbyoTrYm0p2/U= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+96973+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1670261355406472.9703817697763; Mon, 5 Dec 2022 09:29:15 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id 3PRQYY1788612x99Lj2sNn7e; Mon, 05 Dec 2022 09:29:15 -0800 X-Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web10.21774.1670261354620940239 for ; Mon, 05 Dec 2022 09:29:14 -0800 X-Received: from localhost.localdomain (unknown [47.201.8.94]) by linux.microsoft.com (Postfix) with ESMTPSA id 9D6F120B83DC; Mon, 5 Dec 2022 09:29:13 -0800 (PST) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 9D6F120B83DC From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Sean Brogan , Michael D Kinney , Liming Gao Subject: [edk2-devel] [PATCH v1 1/5] .pytool/Readme.md: Add reference to new build instructions Date: Mon, 5 Dec 2022 12:28:35 -0500 Message-Id: <20221205172839.2859-2-mikuback@linux.microsoft.com> In-Reply-To: <20221205172839.2859-1-mikuback@linux.microsoft.com> References: <20221205172839.2859-1-mikuback@linux.microsoft.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,mikuback@linux.microsoft.com X-Gm-Message-State: NzCi1VC6CpPgIz6f0mN4wdNmx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1670261355; bh=M7+jHrHLDHWd6tUfceW19JxaRVHbrib5tIBY3+IanVo=; h=Cc:Date:From:Reply-To:Subject:To; b=Hdzb15KHdu+ysQO+CwdnN893iJVvwhN9M9RNG6RO/w7vH0ipNv4yS/wuWPG5U9THsah X1EI9/49SK3Cd+mI4iBEGPWfw3GvzGWkovD4Z4jej/Bpztd8CKR0umKyucFeEjca3Kzuj hWkGOV5MndX+oOyOMvIYhnkDZq4rEDhWVB8= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1670261357418100002 Content-Type: text/plain; charset="utf-8" From: Michael Kubacki Adds a reference to the new build instructions on the TianoCore wiki that currently describe building with containers and Stuart. Cc: Sean Brogan Cc: Michael D Kinney Cc: Liming Gao Signed-off-by: Michael Kubacki --- .pytool/Readme.md | 52 +++++++------------- 1 file changed, 17 insertions(+), 35 deletions(-) diff --git a/.pytool/Readme.md b/.pytool/Readme.md index 9c7b7f9abbec..b2688d168753 100644 --- a/.pytool/Readme.md +++ b/.pytool/Readme.md @@ -1,5 +1,12 @@ # Edk2 Continuous Integration =20 +This file focuses on information for those working with the `.pytools` dir= ectory +directly or interested in lower-level details about how CI works. + +If you just want to get started building code, visit +[Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki= /Build-Instruction) +on the TianoCore wiki. + ## Basic Status =20 | Package | Windows VS2019 (IA32/X64)| Ubuntu GCC (IA32/X64/A= RM/AARCH64) | Known Issues | @@ -82,43 +89,18 @@ easily and consistently running locally and in a cloud = ci environment. To do that a few steps should be followed. Details of EDKII Tools can be found = in the [docs folder here](https://github.com/tianocore/edk2-pytool-extensions/tre= e/master/docs) =20 -### Prerequisites - -1. A supported toolchain (others might work but this is what is tested and= validated) - * Windows 10: - * VS 2017 or VS 2019 - * Windows SDK (for rc) - * Windows WDK (for capsules) - * Ubuntu 18.04 or Fedora - * GCC5 - * Easy to add more but this is the current state -2. Python 3.7.x or newer on path -3. git on path -4. Recommended to setup and activate a python virtual environment -5. Install the requirements `pip install --upgrade -r pip-requirements.txt` - ### Running CI =20 -1. clone your edk2 repo -2. Activate your python virtual environment in cmd window -3. Get code dependencies (done only when submodules change) - * `stuart_setup -c .pytool/CISettings.py TOOL_CHAIN_TAG=3D` -4. Update other dependencies (done more often) - * `stuart_update -c .pytool/CISettings.py TOOL_CHAIN_TAG=3D` -5. Run CI build (--help will give you options) - * `stuart_ci_build -c .pytool/CISettings.py TOOL_CHAIN_TAG=3D` - * -p : To build only certain packages use a CSV list - * -a : To run only certain architectures use a CSV l= ist - * -t : To run only tests related to certain targets us= e a - CSV list - * By default all tests are opted in. Then given a package.ci.yaml file= those - tests can be configured for a package. Finally setting the check to t= he - value `skip` will skip that plugin. Examples: - * `CompilerPlugin=3Dskip` skip the build test - * `GuidCheck=3Dskip` skip the Guid check - * `SpellCheck=3Dskip` skip the spell checker - * etc -6. Detailed reports and logs per package are captured in the `Build` direc= tory +Quick notes: + +* By default all CI plugins are opted in. + * Setting the plugin to `skip` as an argument will skip running the plug= in. + Examples: + * `CompilerPlugin=3Dskip` skip the build test + * `GuidCheck=3Dskip` skip the Guid check + * `SpellCheck=3Dskip` skip the spell checker + * etc. +* Detailed reports and logs per package are captured in the `Build` direct= ory. =20 ## Current PyTool Test Capabilities =20 --=20 2.28.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96973): https://edk2.groups.io/g/devel/message/96973 Mute This Topic: https://groups.io/mt/95474035/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-