Re: [PATCH v2 0/6] Edk2 Platform and Core CI for ArmVirtPkg, EmulatorPkg, and OvmfPkg

["Sean" <sean.brogan@microsoft.com>]

Thanks for providing feedback.  
My V10 branch is up which will be sent to the mailing list tomorrow as the V3 patch set unless there are any changes requested.

This now includes a 7th patch which converts the edk2 ReadMe.md to ReadMe.rst and shows the Platform CI status.  The other package ReadMe files that describe how to run locally have been updated to remove the status and some text changed.  Finally they were moved into the PlatformCI folder.  This should now align with Laszlo's requests.  

https://github.com/spbrogan/edk2/tree/PlatformAndCoreCIForOvmfArmVirtEmulatorPackages_v10

Thanks
Sean



-----Original Message-----
From: Ard Biesheuvel <ard.biesheuvel@arm.com> 
Sent: Thursday, April 23, 2020 1:42 AM
To: Sean Brogan <sean.brogan@microsoft.com>; Laszlo Ersek <lersek@redhat.com>; michael.kubacki@outlook.com; devel@edk2.groups.io
Cc: Andrew Fish <afish@apple.com>; Bret Barkelew <Bret.Barkelew@microsoft.com>; Jordan Justen <jordan.l.justen@intel.com>; Leif Lindholm <leif@nuviainc.com>; Liming Gao <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Ray Ni <ray.ni@intel.com>
Subject: Re: [EXTERNAL] Re: [PATCH v2 0/6] Edk2 Platform and Core CI for ArmVirtPkg, EmulatorPkg, and OvmfPkg

On 4/23/20 2:45 AM, Sean Brogan wrote:
> I was hoping that because it wasn't "HTML tag soup" that build status could be front and center in the package readme as I find that more in line with expectations on github based projects.   Nesting it deeper in the package just means less people find it when looking at your package.   But I could see a few ways to solve it so I am looking for feedback and alignment before doing anything else.
> 
> Option 1.
> 
> 1. Add the Platform CI build status for the three platforms to the Edk2 repo readme since these are platforms in edk2 this makes sense and brings the most visibility to their status and the existence of the builds.
> 2. Convert edk2 repo readme to RST so it avoids "HTML tag soup"
> 3. Move the remaining part of the OvmfPkg/Readme.rst file into OvmfPkg/PlatformCI/Readme.md  (I prefer MD when not doing large tables of links as it is easier to write and slightly easier to read as plain text).
> 4. Do step 3 for ArmVirtPkg and EmulatorPkg too
> 
> Option 2.
> 1. Leave the ReadMe.rst at the root of each package but only include 
> the build status table and add a link to the PlatformCi/ReadMe.md 2. 
> Move the Pytool and Platform CI focused readme contents to 
> PlatformCI/ReadMe.md
> 
> Option 3.
> 
> Something else.
> 

Given the intent to make it a requirement that changes don't regress on these platforms we've selected, I think having the CI build (and boot!) status of these platforms front and center makes sense.

I am absolutely fine with using either .md or .rst depending on the needs of the individual use cases.

So I suppose that means option #1, or some variation thereof.

> Finally does anyone have a strong preference for ReadMe vs README vs readme vs Readme vs ReAdMe?  I see a mix of these in the edk2 code tree.
> 

ReadMe is the most idiomatic given the EDK2 coding style, but I could live with README as well.