Add a "coverage badge"

[brynrhodes]

Support repositories ability to advertise coverage using a badge that shows coverage percentage

[preston]

FYI HL7 has a public Shields server that probably does what you want. It supports both dynamic and static badges. https://shields.foundry.hl7.org/

[preston]

Submitted via PR #75 , which depends on #74.

[preston]

@brynrhodes Do the dynamic Shields badges at the top of the README resolve this?

[brynrhodes]

The badges at the top of the readme are great, but they are about this repository. This issue was more about making badges available to engine repositories to state their level of coverage with respect to these tests. I'm not sure a) what that looks like technically, nor b) whether anyone would actually do that?

[preston]

Ah ok I see what you're saying. Technically we can already do this with HL7's "Shields" server using "Dynamic JSON Badges". The way it works is you use a normal Markdown image link to the Shields server with a data file URL, JSON path string, and other query params and then the Shields server dynamically creates the badge for the client. The only thing that's missing is a "percentage passing" statistic to query for, as I'm not sure this can be done dynamically. For example:

[preston]

Here's the documentation and badge builder page: https://shields.foundry.hl7.org/badges/dynamic-json-badge

[brynrhodes]

[brynrhodes]

Is there some refresh that needs to happen in order for new results to be available at cql-tests-results.quality.hl7.org?

[preston]

Yes .. The deployment is automatic, but the build is manual only because the hl7-bot account doesn't have privileges to install the CI system build script hook. I'd prefer going automated :)

[preston]

i just pushed that build for you .. it's live now: https://cql-tests-results.quality.hl7.org/index.json

[brynrhodes]

Fantastic, just added it to the java engine project, as soon as that PR merges we'll get to see one live, then I'll recommend that other engines add badges to their repos as well.

[preston]

If you want to create a ticket for "percentage" statistics in the results schema, I'll get to it when I can.