sdkman / sdkman-cli

The SDKMAN! Command Line Interface
https://sdkman.io
Apache License 2.0
6.12k stars 630 forks source link

💡 Feature: [version badges on shield.io] 📛 #1045

Open adriens opened 2 years ago

adriens commented 2 years ago

💡 Feature request

The main idea would to be able to get a dedicated SDK%AN! shield that could se embedded on sdks homepages (maven, schemacrawler,...) ...so people know, just by visiting GH homepage that the software can be distributed on SDKMAN!

⚡ Benefits

  1. Let community know that software is distributed on SDKMAN (like for npm, chocolatey,...)
  2. Make software distribution always easier
  3. Make promotion of sdkman
  4. Make better core softwares homepages (on GH but not only)

👇 Requirements

🚀 Actions

sualeh commented 2 years ago

@adriens - great minds think alike - I had the same idea and emailed @marc0der 😄

marc0der commented 2 years ago

I love this! What would you expect the badge to display? I see there are many variants. BTW, everything on our API is already publicly available.

adriens commented 2 years ago

What would you expect the badge to display?

I guess, the first one would be the current version :

image

Then, as for Docker images or chocolatey packages : the number of downloads :

image

BTW, everything on our API is already publicly available.

Where can I refer to it please ?

marc0der commented 2 years ago

Sounds very simple to do, although I'm confused about this requirement you posted:

Make sdk list available as a public API

My guess would be that you are after surfacing the following instead:

adriens commented 2 years ago

Sounds very simple to do, although I'm confused about this requirement you posted:

I was not aware of where to find it 😸

My guess would be that you are after surfacing the following instead: the current default version of your candidate on SDKMAN (we have this already)

That would be perfect !

Do you want me to give a try to fill an issue on shields.io ?

adriens commented 2 years ago

🚀 I'm filling this issue right now

adriens commented 2 years ago

Badge request done cf https://github.com/badges/shields/issues/7581

adriens commented 2 years ago

🚀

adriens commented 2 years ago

@marc0der I got this feedback : https://github.com/badges/shields/issues/7581#issuecomment-1032928585

image

Then it appears it's not a real (json) API :

image

Could you drop a reply to chris48s on the last reply ?

adriens commented 2 years ago

⚠️ As mentionned on the issue :

image

marc0der commented 2 years ago

Hi @adriens, even though this API is publicly available, we don't have swagger on our endpoints at the moment. That said, we do have cucumber features describing our endpoints clearly.

Even though such a badge would be nice to have, we simply don't have the capacity to retrofit all our endpoints with swagger right now.

adriens commented 2 years ago

@marc0der , is there a place where we can get sdk details in json (instead of html)? I'd like to try something 🤞

marc0der commented 2 years ago

No sorry, nothing at the moment. In future, we will have JSON/HTTP APIs as we roll out our new Rust extensions. But for the moment it is all CSV/HTTP.