[edk2-devel] [Patch v3 22/22] Readme.md: Add CI build status badges
Michael D Kinney
michael.d.kinney at intel.com
Thu Oct 31 04:42:36 UTC 2019
Hi Leif,
Thanks for noticing the reference to the ci dir. That content
Has been moved to .azurepipelines directory and the Readme.md
filename is correct there.
I will split out the format changes to this Readme.md into its
own patch so it will not be mixed with the CI features.
I agree that the table with CI status is not very readable.
This is true in MD files for most long hyperlinks, especially
when they are put into a table format. We can see if we can
improve the readability to make it easier to maintain, but
will likely still be long lines.
Mike
> -----Original Message-----
> From: Leif Lindholm <leif.lindholm at linaro.org>
> Sent: Tuesday, October 29, 2019 7:58 PM
> To: Kinney, Michael D <michael.d.kinney at intel.com>
> Cc: devel at edk2.groups.io; Andrew Fish <afish at apple.com>;
> Laszlo Ersek <lersek at redhat.com>
> Subject: Re: [Patch v3 22/22] Readme.md: Add CI build
> status badges
>
> On Tue, Oct 29, 2019 at 12:55:17PM -0700, Michael D
> Kinney wrote:
> > 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 <afish at apple.com>
> > Cc: Laszlo Ersek <lersek at redhat.com>
> > Cc: Leif Lindholm <leif.lindholm at linaro.org>
> > Signed-off-by: Michael D Kinney
> <michael.d.kinney at intel.com>
> > ---
> > 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 |
>
> This may sound like nitpicking, but I think it's
> important for
> messaging: we aren't listing tolchains, we are listing
> toolchain profiles. For VS, we are actually adding new
> profiles for each version, so that statement is not
> misleading. However, GCC5 is highly misleading (it is
> the profile we use for anything gcc5 onwards).
>
> I don't think we can usefully pull in information about
> the toolchain actually used, so I think the name of the
> column should really be toolchain profile.
>
> Even given that, I think it is time we create an
> abstracted GCC_CURRENT toolchain profile, pointing to
> GCC5. But if we rename the column, that may not be a
> prerequisite for this set.
>
> > +| :-------- | :-------- | :---- | :----- | :---- | :-
> -- | Windows |
> > +| VS2019 | master | [](ht
> tps://dev.a
> > +| zure.com/tianocore/edk2-ci-
> play/_build/latest?definitionId=14&branc
> > +| hName=master) | [](https://dev.azure.com/tianocore/edk2-
> ci-play/_build/l
> > +| atest?definitionId=14&branchName=master) | [](
> > +| https://dev.azure.com/tianocore/edk2-ci-
> play/_build/latest?definiti
> > +| onId=14&branchName=master)| Ubuntu | GCC5 | master
> | [](https
> ://dev.azur
> > +| e.com/tianocore/edk2-ci-
> play/_build/latest?definitionId=15&branchNa
> > +| me=master) | [](https://dev.azure.com/tianocore/edk2-
> ci-play/_build/l
> > +| atest?definitionId=15&branchName=master) | [](
> > +| https://dev.azure.com/tianocore/edk2-ci-
> play/_build/latest?definiti
> > +| onId=15&branchName=master) |
>
> I have one problem with the above, which is that it
> turns an otherwise very readable in text mode file
> (which is half the point of .md) into what looks a
> little bit like a transmission error.
>
> While I agree there is value in having this on the
> default loaded github webpage, do we have other options?
>
> > +
> > +[More CI Build information](ci/readme.md)
>
> I don't see this file in the tree?
> Which is good, beacuse it doesn't follow name standards.
>
> > +
> > +## License Details
> > +
> > +[](License.txt)
> > +
>
> I don't mind this addition, but I think it should be a
> separate patch.
> I also think it would be best to hold this back until
> we've submoduled some of those otherwise licensed
> components.
> There is a very real likelihood of people skimming,
> seeing the image and ignoring the text.
>
> > 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
> > +
>
> No objections to change, but it is unrelated to this
> patch.
>
> > * [TianoCore](http://www.tianocore.org)
> > * [EDK
> >
> II](https://github.com/tianocore/tianocore.github.io/wik
> i/EDK-II)
> > * [Getting Started with EDK
> >
> II](https://github.com/tianocore/tianocore.github.io/wik
> i/Getting-Star
> > ted-with-EDK-II) @@ -29,7 +43,8 @@ are listed in
> > [Maintainers.txt](Maintainers.txt).
> > * [How To
> >
> Contribute](https://github.com/tianocore/tianocore.githu
> b.io/wiki/How-
> > To-Contribute)
> > * [Release
> >
> Planning](https://github.com/tianocore/tianocore.github.
> io/wiki/EDK-II
> > -Release-Planning)
> >
> > -# Code Contributions
> > +## Code Contributions
> > +
>
> No objection to change, but it is unrelated to this
> patch.
>
> > 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
>
> No objection to change, but it is unrelated to this
> patch.
>
> >
> > 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
>
> No objection to change, but it is unrelated to this
> patch.
>
> >
> > ```
> > From: Contributor Name <contributor at example.com> @@ -
> 115,14 +130,14
> > @@ Full-commit-message
> > Signed-off-by: Contributor Name
> <contributor at example.com> ```
> >
> > -## Notes for sample patch email
> > +### Notes for sample patch email
>
> No objection to change, but it is unrelated to this
> patch.
>
> >
> > * 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
>
> No objection to change, but it is unrelated to this
> patch.
>
> >
> > * `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
> > <contributor at example.com>
> > * `Signed-off-by` is the contributor's signature
> identifying them
> > by their real/legal name and their email address.
> >
> > -# Submodules
> > +## Submodules
>
> No objection to change, but it is unrelated to this
> patch.
>
> /
> Leif
>
> >
> > 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
> >
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#49711): https://edk2.groups.io/g/devel/message/49711
Mute This Topic: https://groups.io/mt/39614230/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list