Cirrus-ci-docs: Proper badge support with shields.io

[abitrolly]

I am hitting GitHub caches issue described in #223. https://api.cirrus-ci.com/github/yakshaveinc/linux.svg shows as passing, but repository status is "not found"

The solution is to add first hand support to https://shields.io which may better work around GitHub caching requests https://github.com/badges/shields/blob/master/doc/TUTORIAL.md

[RDIL]

Related:

279

223

[RDIL]

I can create the badges on shields's end if you are able to add an API URL that responds with passing, failing, or notFound.

[fkorotkov]

There is now a JSON endpoint to get the badge information. Simply change .svg to .json. For example, https://api.cirrus-ci.com/github/yakshaveinc/linux.json

@RDIL do you still have bandwidth to take a loot at submitting a PR to https://github.com/badges/shields to add the support?

[RDIL]

Yeah, taking the weekend off though. I’ll look into it on Monday.

[fkorotkov]

Thank you!

[RDIL]

Okay going to take a look at this now

[RDIL]

Okay, PR is open, feel free to help out :)

[awnumar]

I'm experiencing the same issue but both the svg and json links are returning not+found:

https://api.cirrus-ci.com/github/awnumar/memguard.svg
https://api.cirrus-ci.com/github/awnumar/memguard.json

So I'm not sure if the proposed shields.io solution would work since it pulls from the json endpoint.

[fkorotkov]

@awnumar there are no master builds for the repository. You can specify branch via ?branch=cirrus query like this: https://api.cirrus-ci.com/github/awnumar/memguard.svg?branch=cirrus

[awnumar]

@fkorotkov Heyy nice one thanks!

[fkorotkov]

@RDIL do you still have time to follow up on https://github.com/badges/shields/pull/3502? Or should I take over?

[RDIL]

Honestly, I really have to get something done before Tuesday, so I can't really right now. If you comment suggestions, I'll accept them though.