illinois-ceesd / emirge

Environment for MirgeCom
MIT License
4 stars 3 forks source link

Add CI badge to README #7

Closed inducer closed 4 years ago

matthiasdiener commented 4 years ago

Done.

inducer commented 4 years ago

Actually, not quite. (And I learned this the hard way, too.) This snippet:

![CI test](https://github.com/illinois-ceesd/emirge/workflows/CI%20test/badge.svg)

will include all CI runs (so some stupid pull request failing CI will make your badge red). You want

.. image:: https://github.com/inducer/pyopencl/workflows/CI/badge.svg?branch=master&event=push
    :alt: Github Build Status
    :target: https://github.com/inducer/pyopencl/actions?query=branch%3Amaster+workflow%3ACI+event%3Apush

(Sorry, that's ReST, not Markdown, but I'm guessing you can translate.) That's actually also not totally right, since it's too narrow. It won't include scheduled runs (#9). But I actually don't know how to fix that.

matthiasdiener commented 4 years ago

just tested it - a failing pull request test does not seem to create a red badge (https://github.com/illinois-ceesd/emirge/pull/10)

inducer commented 4 years ago

Huh weird, looks like you're right. Not sure what I was seeing then.

Found another wrinkle though: The badge should link to the CI results. :P