Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up shields.io badges #29

Open
hobofan opened this issue Oct 22, 2022 · 3 comments
Open

Set up shields.io badges #29

hobofan opened this issue Oct 22, 2022 · 3 comments

Comments

@hobofan
Copy link
Member

hobofan commented Oct 22, 2022

Badges in READMEs can be a really good way to improve the developer experience for an ecosystem, as they can provide a consistently recognizable link to a website with more information (like the bcr-ui) in an otherwise unstructured (= of always varying structure) block of text.

Shields.io provides the commonly used service for that (with integrations to all the popular package managers): https://shields.io/category/version

Examples for what the badge could look like:

I haven't quite figured out yet on how to get them integrated to their website (I think via contributing it to https://github.com/badges/shields ?). EDIT: https://github.com/badges/shields/blob/master/doc/TUTORIAL.md

To enable that I assume we would have to provide some endpoint or URL template that would allow for retrieving the latest version of a module. I assume that wouldn't be to hard to integrate into the build process of Next.js 🤞.

@alexeagle
Copy link
Contributor

alexeagle commented Aug 10, 2023

There is already a badge available for the most recent release of a ruleset, e.g. for rules_pkg
GitHub release (with filter)
so I don't think there's enough value to merit the work it would take to make the contribution to Shields along with the user confusion of which type of badge to use.

I'd like to re-purpose this issue to suggest we display badges from shields.io on the bcr ui, like download count, open issues, etc. This gives a bit of a health signal for the ruleset, like the bazel-catalog is trying to do.

@sgammon
Copy link
Contributor

sgammon commented Aug 14, 2023

@alexeagle tagged me so i can share this message from slack :) if I get time I may try to contribute some of these features upstream to Shields.io.

we made these sick badges to show off our Bzlmod support, if you guys want them feel free to steal from the README. It's a SVG data URL directly from the Bazel logo so it should both be faithful to their design and portable

Screenshot 2023-08-13 at 2 55 55 PM

project: https://github.com/sgammon/rules-graalvm

@sgammon
Copy link
Contributor

sgammon commented Aug 14, 2023

filed @ badges/shields#9474

Initial PR just adds a bazel logo option. Next I'll try to add a version badge, but I don't know yet how easy that is to plug in to BCR's JSON endpoints. We'll see.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants