public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Leif Lindholm" <leif.lindholm@linaro.org>
To: "Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>,
	"devel@edk2.groups.io" <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
Date: Thu, 7 Nov 2019 23:16:41 +0000	[thread overview]
Message-ID: <20191107231641.GA16820@bivouac.eciton.net> (raw)
In-Reply-To: <E92EE9817A31E24EB0585FDF735412F5B9E00DB2@ORSMSX113.amr.corp.intel.com>


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
> > >

  reply	other threads:[~2019-11-07 23:16 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-07  1:13 [Patch v4 00/22] Enable Phase 1 of EDK II CI Michael D Kinney
2019-11-07  1:13 ` [Patch v4 01/22] Maintainers.txt: Add continuous integration(CI) directories Michael D Kinney
2019-11-07  1:13 ` [Patch v4 02/22] .gitignore: Ignore python compiled files, extdeps, and vscode Michael D Kinney
2019-11-07 10:26   ` Laszlo Ersek
2019-11-07  1:13 ` [Patch v4 03/22] requirements.txt: Add python pip requirements file Michael D Kinney
2019-11-07 10:39   ` Laszlo Ersek
2019-11-07 15:43     ` Leif Lindholm
2019-11-07 17:44     ` Michael D Kinney
2019-11-08 13:12       ` Laszlo Ersek
2019-11-08 16:58         ` Michael D Kinney
2019-11-07 10:49   ` Laszlo Ersek
2019-11-07  1:13 ` [Patch v4 04/22] BaseTools: Add RC_PATH define for VS2017/2019 Michael D Kinney
2019-11-07  1:13 ` [Patch v4 05/22] BaseTools: Add YAML files with path env and tool extdeps Michael D Kinney
2019-11-07  1:13 ` [Patch v4 06/22] BaseTools: Add BaseTools plugins to support CI Michael D Kinney
2019-11-07  1:13 ` [Patch v4 07/22] .pytool/Plugin: Add CI plugins Michael D Kinney
2019-11-07  6:58   ` Liming Gao
2019-11-07  1:13 ` [Patch v4 08/22] CryptoPkg: Add YAML file for CI builds Michael D Kinney
2019-11-07  5:06   ` Wang, Jian J
2019-11-07  1:13 ` [Patch v4 09/22] FatPkg: " Michael D Kinney
2019-11-07  2:12   ` Ni, Ray
2019-11-07  1:13 ` [Patch v4 10/22] FmpDevicePkg: " Michael D Kinney
2019-11-07  1:13 ` [Patch v4 11/22] MdeModulePkg: " Michael D Kinney
2019-11-07  3:03   ` Wu, Hao A
2019-11-07 20:02     ` Michael D Kinney
2019-11-07  1:13 ` [Patch v4 12/22] MdePkg: " Michael D Kinney
2019-11-07  1:13 ` [Patch v4 13/22] NetworkPkg: " Michael D Kinney
2019-11-07  1:13 ` [Patch v4 14/22] PcAtChipsetPkg: Add YAML files " Michael D Kinney
2019-11-07  2:12   ` Ni, Ray
2019-11-07  1:13 ` [Patch v4 15/22] SecurityPkg: " Michael D Kinney
2019-11-07  5:08   ` Wang, Jian J
2019-11-07  1:13 ` [Patch v4 16/22] ShellPkg: Add YAML file " Michael D Kinney
2019-11-07  2:12   ` Ni, Ray
2019-11-07  1:13 ` [Patch v4 17/22] UefiCpuPkg: " Michael D Kinney
2019-11-07  2:12   ` Ni, Ray
2019-11-07 10:42   ` Laszlo Ersek
2019-11-07 10:48     ` Laszlo Ersek
2019-11-07 19:23       ` [edk2-devel] " Michael D Kinney
2019-11-07 19:33         ` Sean
2019-11-08 14:43           ` Laszlo Ersek
2019-11-07  1:13 ` [Patch v4 18/22] SignedCapsulePkg: Use BaseCryptLibNull to reduce package CI time Michael D Kinney
2019-11-07  1:13 ` [Patch v4 19/22] .pytool: Add CISettings.py and Readme.md Michael D Kinney
2019-11-07 16:16   ` [edk2-devel] " rebecca
2019-11-07  1:13 ` [Patch v4 20/22] .azurepipelines: Add Azure Pipelines YML configuration files Michael D Kinney
2019-11-07  1:13 ` [Patch v4 21/22] .mergify: Add Mergify YML pull request rules configuration file Michael D Kinney
2019-11-07  1:13 ` [Patch v4 22/22] Readme.md: Add CI build status badges Michael D Kinney
2019-11-07 10:44   ` Laszlo Ersek
2019-11-07 16:00   ` Leif Lindholm
2019-11-07 19:42     ` Michael D Kinney
2019-11-07 23:16       ` Leif Lindholm [this message]
2019-11-08  9:24       ` Leif Lindholm
2019-11-07 15:35 ` [Patch v4 00/22] Enable Phase 1 of EDK II CI Liming Gao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191107231641.GA16820@bivouac.eciton.net \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox