From mboxrd@z Thu Jan 1 00:00:00 1970 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 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=TVqPGBki; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) 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 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1670261354; bh=filjMkCCwOxwwQnWHIhrH9ymCT4XivigRSJ3hz5o028=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=TVqPGBkij7J+UrMN2nkwAoaFkXkh4jtNs8Mw9jQFNIccPdyxF4hdCUlhNdtKX8tRR 90GunkG0+vbXiKLLD3ORZdGrLid5rtP9TGsd6+Eq0f65tnIruKY/pZ1iDbSIxsgTnd QYbyJib12mc1nJvQgtKPF/5LdmutsXn1TlDWaOnQ= From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Sean Brogan , Michael D Kinney , Liming Gao Subject: [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> X-Mailer: git-send-email 2.28.0.windows.1 In-Reply-To: <20221205172839.2859-1-mikuback@linux.microsoft.com> References: <20221205172839.2859-1-mikuback@linux.microsoft.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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` d= irectory +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/wi= ki/Build-Instruction) +on the TianoCore wiki. + ## Basic Status =20 | Package | Windows VS2019 (IA32/X64)| Ubuntu GCC (IA32/X64= /ARM/AARCH64) | Known Issues | @@ -82,43 +89,18 @@ easily and consistently running locally and in a clou= d ci environment. To do that a few steps should be followed. Details of EDKII Tools can be foun= d in the [docs folder here](https://github.com/tianocore/edk2-pytool-extensions/t= ree/master/docs) =20 -### Prerequisites - -1. A supported toolchain (others might work but this is what is tested a= nd 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.t= xt` - ### 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= list - * -t : To run only tests related to certain targets = use a - CSV list - * By default all tests are opted in. Then given a package.ci.yaml fi= le those - tests can be configured for a package. Finally setting the check to= the - 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` dir= ectory +Quick notes: + +* By default all CI plugins are opted in. + * Setting the plugin to `skip` as an argument will skip running the pl= ugin. + 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` dire= ctory. =20 ## Current PyTool Test Capabilities =20 --=20 2.28.0.windows.1