Add a "Bors enabled" badge for marketing/advertising

It’s pretty common for DevOps services to have a nice badge/shield that you can put in the README of your repository. For example, here is what the “Dependabot enabled” badge looks like:

Dependabot

Clicking on the badge takes you to the Dependabot home page.

Could we create a badge for Bors? Something like “Bors enabled” or “Powered by Bors” or “CI always green due to Bors”. And clicking on the badge would bring you to https://bors.tech.

Dependabot uses https://badgen.net to generate their badges. Badgen badges are nice because they have the little icon in the badge, along with the text.

I think that creating a Bors badge would be relatively straightforward, and would only require a PR to https://github.com/badgen/badgen-icons/tree/master/icons to add an appropriate SVG of the Bors logo.

But first, we’d have to decide on the design of the badge, specifically the text content and the choice of color.

1 Like

Here’s an example of what it might look like:

Bors

But instead of the Git icon, we’d have the Bors eye.

The above icon was generated by the following Markdown:

[![Bors](https://badgen.net/badge/Bors/enabled?icon=git&color=green)](https://bors.tech)

I like the idea of having a badge design, but I don’t really want something that would involve inverting the colors on the eye. Maybe something a bit more custom, rather than just using a service like that?

enabled

1 Like

That’s a great idea.

And if it’s going to be custom, perhaps you can make it a little bigger? That way the Bors logo can show up in better detail/higher resolution.

Bump.

@notriddle Any thoughts on making the badge a little bigger and increasing the resolution?

Also, if we don’t use a service, where should we host the image file? Could we host it on the bors.tech domain? Maybe somewhere like https://bors.tech/badge.svg

Yeah, hosting it from bors.tech would be the best way to do it. Here’s a better-resolution version, uploaded there. https://bors.tech/images/badge_small.svg

Can make a bigger one, but a lot of the point of having a badge like this is that it gets shown in a row along with a bunch of other badges. That use case wants it to be the same height, at least. But you or I could make a bigger one as well.

1 Like

That looks great!

Since it’s an SVG file now, anyone can rescale it to make it as big as they want without having to worry about resolution.

So I like the idea of leaving it this size. And if a user needs a larger size, they can specify it in the Markdown.

For example, this would be the default use:

[![Bors enabled](https://bors.tech/images/badge_small.svg)](https://bors.tech)

Which renders like this:

Bors enabled

And if someone wants a larger size, they could do this (at least in Discourse markdown, not sure what the GitHub markdown syntax is):

[![Bors enabled|104x20,150%](https://bors.tech/images/badge_small.svg)](https://bors.tech)

Which renders in Discourse like this:

Bors enabled

I guess the only question left is: what should the target of the link be? Should it be https://bors.tech or https://github.com/bors-ng/bors-ng? Or some third option?

Probably something like https://app.bors.tech/repositories/3. A typical badge-using repository, as far as I know, will have its badges link to a project-specific status page. Since bors has a public, project-specific status page, we should make it so that the bors dashboard page gives you copy-paste-able markup that will link to it.

Discourse and GitHub both support HTML, so I’d just use that.

<a href="https://app.bors.tech/repositories/3"><img src="https://bors.tech/images/badge_small.svg" width=156 height=30 alt="bors enabled"></a>

bors enabled

1 Like

Out of curiousity: If a user uninstalls Bors from a repo and then reinstalls it on the same repo, does the URL to the status page (e.g. https://app.bors.tech/repositories/3) stay the same, or does it change?

It changes.

This is a great idea. Very similar to what Travis does. Are you planning on implementing it? If not, I can look through the code and see if I can figure out how to implement it.

I’m not planning to implement it. If you have the time, go ahead!

@notriddle Take a look: https://github.com/bors-ng/bors-ng/pull/676

1 Like