From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga12.intel.com (mga12.intel.com []) by mx.groups.io with SMTP id smtpd.web12.707.1572378927372028712 for ; Tue, 29 Oct 2019 12:55:30 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=fail (domain: intel.com, ip: , mailfrom: michael.d.kinney@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 29 Oct 2019 12:55:31 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,245,1569308400"; d="scan'208";a="211170271" Received: from mdkinney-mobl2.amr.corp.intel.com ([10.251.0.39]) by fmsmga001.fm.intel.com with ESMTP; 29 Oct 2019 12:55:29 -0700 From: "Michael D Kinney" To: devel@edk2.groups.io Cc: Andrew Fish , Laszlo Ersek , Leif Lindholm Subject: [Patch v3 22/22] Readme.md: Add CI build status badges Date: Tue, 29 Oct 2019 12:55:17 -0700 Message-Id: <20191029195517.20028-23-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.21.0.windows.1 In-Reply-To: <20191029195517.20028-1-michael.d.kinney@intel.com> References: <20191029195517.20028-1-michael.d.kinney@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit https://bugzilla.tianocore.org/show_bug.cgi?id=2315 Update Readme.md with status badges from the most recent EDK II Continuous Integration(CI) build. Cc: Andrew Fish Cc: Laszlo Ersek Cc: Leif Lindholm Signed-off-by: Michael D Kinney --- Readme.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/Readme.md b/Readme.md index 27e4ce0771..37183c3265 100644 --- a/Readme.md +++ b/Readme.md @@ -3,6 +3,19 @@ A modern, feature-rich, cross-platform firmware development environment for the UEFI and PI specifications from www.uefi.org. +## Build Status + +| Host Type | Toolchain | Branch | Build Status | Test Status | Code Coverage | +| :-------- | :-------- | :---- | :----- | :---- | :--- | +| Windows | VS2019 | master | [![Build Status](https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/Edk2%20Windows%20VS2019%20CI?branchName=master)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=14&branchName=master) | [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/tianocore/edk2-ci-play/14.svg)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=14&branchName=master) | [![Code Coverage](https://img.shields.io/badge/coverage-coming_soon-blue)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=14&branchName=master)| +| Ubuntu | GCC5 | master | [![Build Status](https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/Edk2%20Ubuntu%20GCC5%20CI?branchName=master)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=15&branchName=master) | [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/tianocore/edk2-ci-play/15.svg)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=15&branchName=master) | [![Code Coverage](https://img.shields.io/badge/coverage-coming_soon-blue)](https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=15&branchName=master) | + +[More CI Build information](ci/readme.md) + +## License Details + +[![License](https://img.shields.io/badge/license-BSD--2--Clause--Patent-blue)](License.txt) + The majority of the content in the EDK II open source project uses a [BSD-2-Clause Plus Patent License](License.txt). The EDK II open source project contains the following components that are covered by additional licenses: @@ -20,7 +33,8 @@ contains the following components that are covered by additional licenses: The EDK II Project is composed of packages. The maintainers for each package are listed in [Maintainers.txt](Maintainers.txt). -# Resources +## Resources + * [TianoCore](http://www.tianocore.org) * [EDK II](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II) * [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II) @@ -29,7 +43,8 @@ are listed in [Maintainers.txt](Maintainers.txt). * [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute) * [Release Planning](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning) -# Code Contributions +## Code Contributions + To make a contribution to a TianoCore project, follow these steps. 1. Create a change description in the format specified below to use in the source control commit log. @@ -57,7 +72,7 @@ To make a contribution to a TianoCore project, follow these steps. Contributions using other licenses might be accepted, but further review will be required. -# Developer Certificate of Origin +## Developer Certificate of Origin Your change description should use the standard format for a commit message, and must include your `Signed-off-by` signature. @@ -104,7 +119,7 @@ By making a contribution to this project, I certify that: this project or the open source license(s) involved. ``` -# Sample Change Description / Commit Message +## Sample Change Description / Commit Message ``` From: Contributor Name @@ -115,14 +130,14 @@ Full-commit-message Signed-off-by: Contributor Name ``` -## Notes for sample patch email +### Notes for sample patch email * The first line of commit message is taken from the email's subject line following `[Repository/Branch PATCH]`. The remaining portion of the commit message is the email's content. * `git format-patch` is one way to create this format -## Definitions for sample patch email +### Definitions for sample patch email * `Repository` is the identifier of the repository the patch applies. This identifier should only be provided for repositories other than @@ -141,7 +156,7 @@ Signed-off-by: Contributor Name * `Signed-off-by` is the contributor's signature identifying them by their real/legal name and their email address. -# Submodules +## Submodules Submodule in EDK II is allowed but submodule chain should be avoided as possible as we can. Currently EDK II contains two submodules -- 2.21.0.windows.1