Github Releases Download counter #404
Conversation
possible combinations: - `/github/downloads/:user/:repo/latest/total.svg` - `/github/downloads/:user/:repo/:release_id/total.svg` - `/github/downloads/:user/:repo/:release_id/:asset_name.svg`
|
How about a combination that counts all downloads of all releases? |
|
@Alexander01998 I thought about it, but that could be heavy on resources as it would have to iterate over releases backward in history and make multiple HTTP calls to go through github pagination ... happy to add it (real-simple) if server maintainers think the server can handle it... |
|
Computation-wise, I agree with ahmadnassri. That operation would be way cleaner to add on github's side. Were they to give direct access to that information, we could display it. |
|
It's OK, I can make my own counter for my own repos. |
| var user = match[1]; // eg, qubyte/rubidium | ||
| var repo = match[2]; | ||
| var id = match[3]; | ||
| var asset_name = match[4].toLowerCase(); |
There was a problem hiding this comment.
Can you give an example of asset name apart from total?
There was a problem hiding this comment.
i'm adding the comment inline with examples, any other suggestions for surfacing the examples of this value to visitors on the web page?
There was a problem hiding this comment.
Adding an example badge with a specific asset would be great!
|
Thanks a lot for your contribution! |
+ grab releases by tag name instead of obscure ID + more examples + better labels
|
@espadrine made some minor adjustments, mainly:
I believe this is now final / ready. cheers. |
| downloads += asset.download_count; | ||
| } | ||
| }); | ||
| var label = tag === 'latest' ? 'latest version' : tag; |
There was a problem hiding this comment.
I believe we should be silent if we're showing the latest version, since that feels like a good default (as in, people would expect that to be the case if they didn't see a version).
There was a problem hiding this comment.
I was following examples of existing badges ... they show "latest version", e.g. Crates.io, Gem ...
I'm in favor of silent if latest, or perhaps simply "latest"
happy to change to whatever makes more sense
There was a problem hiding this comment.
I'm in favor of silent if latest.
|
Thanks a lot! |
|
👍 |
Just curious: why multiple HTTP calls? This API call returns information on all releases in a single response. Or parsing this JSON is also a time-consuming operation? |
When having thousands of repos each having hundred of releases, it can indeed be very time-consuming. I made a counter for one of my own repos using Google Apps Script. |
@kefir500 you are correct, I had the impression at the time (for whatever reason) that it was paginated (and honestly it should be, some of those releases count in hundreds) which would have meant many many HTTP calls ... and as @Alexander01998 pointed out, even then there would be a good amount of processing needed for a big / large project with many releases, we already know the service has been struggling with downtime recently, and a big refactor is due .. |
|
and again, happy to add a big loop that goes through all releases and calculates the total if maintainers think its a good idea ... |
|
I believe this is the subject of an ongoing PR. |
|
ah yes: #535 |
possible combinations:
/github/downloads/:user/:repo/latest/total.svg/github/downloads/:user/:repo/:release_id/total.svg/github/downloads/:user/:repo/:release_id/:asset_name.svg