Re: [Patch v4 22/22] Readme.md: Add CI build status badges

["Leif Lindholm" <leif.lindholm@linaro.org>]

On Thu, Nov 07, 2019 at 07:42:27PM +0000, Kinney, Michael D wrote:
> Hi Leif,
> 
> I really like the build status information in Readme.md
> so it is visible whenever anyone navigates to the edk2
> repo.

As do I. Just not at any cost (including nullifying the entire point
of markdown).

> This matches what many other open source projects
> provide.
> 
> GitHub markdown does support HTML, so one idea is to 
> put this content into an HTML table and that would
> allow us to format the Readme.md file with each hyperlink
> on its own line.

I think that might work.

> If we remove the content from a markdown table, then there
> are some other pure markdown methods to put each hyperlink
> on its own line.
> 
> If we can get down to one hyperlink per line in Readme.md,
> does that address your concerns? 

My main problem is that the current version basically looks like a
transfer error. If we can make it look like a compartmentalised
section of the file that provides real value when viewed through
another tool, I'm quite OK with that.

Regards,

Leif

> Thanks,
> 
> Mike
> 
> > -----Original Message-----
> > From: Leif Lindholm <leif.lindholm@linaro.org>
> > Sent: Thursday, November 7, 2019 8:00 AM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>
> > Cc: devel@edk2.groups.io; Andrew Fish <afish@apple.com>;
> > Laszlo Ersek <lersek@redhat.com>
> > Subject: Re: [Patch v4 22/22] Readme.md: Add CI build
> > status badges
> > 
> > On Wed, Nov 06, 2019 at 05:13:49PM -0800, Michael D
> > Kinney wrote:
> > > Update Readme.md with status badges from the most
> > recent EDK II
> > > Continuous Integration(CI) build.
> > >
> > > Cc: Andrew Fish <afish@apple.com>
> > > Cc: Laszlo Ersek <lersek@redhat.com>
> > > Cc: Leif Lindholm <leif.lindholm@linaro.org>
> > > Signed-off-by: Michael D Kinney
> > <michael.d.kinney@intel.com>
> > > ---
> > >  Readme.md | 11 +++++++++++
> > >  1 file changed, 11 insertions(+)
> > >
> > > diff --git a/Readme.md b/Readme.md
> > > index 27e4ce0771..0207923763 100644
> > > --- a/Readme.md
> > > +++ b/Readme.md
> > > @@ -3,6 +3,17 @@
> > >  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-
> > staging/Windows%20VS2019%20CI?branchName=master)](https:
> > //dev.azure.com/tianocore/edk2-ci-
> > play/_build/latest?definitionId=27&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=27&branchName=master) |
> > [![Code Coverage](https://img.shields.io/badge/coverage-
> > coming_soon-blue)](https://dev.azure.com/tianocore/edk2-
> > ci-play/_build/latest?definitionId=27&branchName=master)
> > |
> > > +| Ubuntu    | GCC       | master  | [![Build
> > Status](https://dev.azure.com/tianocore/edk2-ci-
> > play/_apis/build/status/edk2-
> > staging/Ubuntu%20GCC5%20CI?branchName=master)](https://d
> > ev.azure.com/tianocore/edk2-ci-
> > play/_build/latest?definitionId=26&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=26&branchName=master) |
> > [![Code Coverage](https://img.shields.io/badge/coverage-
> > coming_soon-blue)](https://dev.azure.com/tianocore/edk2-
> > ci-play/_build/latest?definitionId=26&branchName=master)
> > |
> > 
> > I'm still not super happy about this.
> > If there is no hacky way of embedding this from another
> > file, could we consider breaking it out into a separate
> > BuildStatus.md and putting a link to that at the top of
> > this file?
> > 
> > /
> >     Leif.
> > 
> > > +
> > > +[More CI Build information](.pytool/Readme.md)
> > > +
> > > +# License Details
> > > +
> > >  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:
> > > --
> > > 2.21.0.windows.1
> > >