You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Wish you could show npm, gem, mvn, Gradle, NuGet, or GHCR badges? Or just query for the download counts? Tough luck; the GitHub Packages API has never exposed publicly-available metadata that other registries provide. This is the solution.
15
+
Wish you could show npm, gem, mvn, Gradle, NuGet, or GHCR badges? Or just query for the download counts? This endpoint makes that possible, using only free GitHub resources; the GitHub Packages API doesn't, and has never, exposed the publicly-available metadata that other registries provide.
If this is [`ipitio/backage`](https://github.com/ipitio/backage), all you have to do is star the repo to have GitHub generate this additional endpoint for your public packages!Otherwise, you can add yourself as described[below](#manual-actions).
23
+
If this is [`ipitio/backage`](https://github.com/ipitio/backage), all you have to do is **star the repo to have GitHub generate this additional endpoint for your public packages!** A service ran by GitHub will add them to its circular priority queue within the next few hours and update the [closed-loop system](https://github.com/pkgforge-dev/backage/releases/latest). Additionally watching and forking the repo, and following the owner, are ways to increase your priority. Yes, I know, but these are the signals that can be automatically processed. Otherwise, if this is a fork or you'd prefer an alternative method, see[below](#manual-actions).
24
24
25
-
A service ran by GitHub will add them to its circular priority queue within the next few hours and update the [closed-loop system](https://github.com/ipitio/backage/releases/latest). Once it does so, replace the parameters with their respective values, scoping to your parsing needs, then access the latest data however you want. Use something like [shields.io/json](https://shields.io/badges/dynamic-json-badge) or [shields.io/xml](https://shields.io/badges/dynamic-xml-badge) to make badges like the ones above or the one [here](https://github.com/badges/shields/issues/5594#issuecomment-2157626147).
25
+
Once added, replace the parameters above with their respective values, scoping to your parsing needs, then access the latest data however you want. Use something like [shields.io/json](https://shields.io/badges/dynamic-json-badge) or [shields.io/xml](https://shields.io/badges/dynamic-xml-badge) to make badges like the ones you just scrolled past or the one [here](https://github.com/badges/shields/issues/5594#issuecomment-2157626147).
26
26
27
27
> [!NOTE]
28
28
> The format can be either `json` or `xml`. You'll need the XML endpoint to evaluate expressions, like filters, with Shields -- see [this issue](https://github.com/ipitio/backage/issues/23).
@@ -162,14 +162,14 @@ As can packages in `owner[/repo]/.xml` files:
162
162
163
163
### Manual Actions
164
164
165
-
To add any other users or organizations not yet [in the index](https://github.com/ipitio/backage/tree/index), add the case-sensitive name of each one on a new line at the top of `owners.txt` on your own fork [here](https://github.com/ipitio/backage/edit/master/owners.txt) and make a pull request. Please add just the name(s) -- ids, repos, and packages will be found automatically! If you'd like the service to forget and ignore any subset of packages, add `owner[/repo[/package]]` to `optout.txt` [here](https://github.com/ipitio/backage/edit/master/optout.txt) and make a pull request.
165
+
To add any other users or organizations not yet [in the index](https://github.com/pkgforge-dev/backage/tree/index), add the case-sensitive name of each one on a new line at the top of `owners.txt` on your own fork [here](https://github.com/pkgforge-dev/backage/edit/master/owners.txt) and make a pull request. Please add just the name(s) -- ids, repos, and packages will be found automatically! If you'd like the service to forget and ignore any subset of packages, add `owner[/repo[/package]]` to `optout.txt` [here](https://github.com/pkgforge-dev/backage/edit/master/optout.txt) and make a pull request.
166
166
167
167
You can create an independent instance for them that'll update faster and more frequently. Simply fork just the `master` branch, then enable Actions from its tab and all disabled workflows. Your own packages will be picked up automatically! If you previously had to edit the `txt` files, you can do so again after the first run. I recommend that you first confirm here that the packages you're interested in are picked up without issue. This centralized repo will then serve as a backup.
0 commit comments