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

badges for executable-only packages are messed up #1860

Open
Gankra opened this issue Sep 27, 2022 · 3 comments
Open

badges for executable-only packages are messed up #1860

Gankra opened this issue Sep 27, 2022 · 3 comments
Labels
E-easy Effort: Should be easy to implement and would make a good first PR mentor This has instructions for getting started

Comments

@Gankra
Copy link

Gankra commented Sep 27, 2022

I filed this downstream but as noted in that description, docs.rs isn't really giving shield.io much to work with to handle the issue.

Downstream issue: badges/shields#8440

Either builds.json should set build_status: true (?) for executables, or it should include an extra flag saying "oh this was just an executable, there was nothing to build".

("Why are you even using the shield" -- because it's a common idiom and what a lot of people reflexively reach for when checking for docs, even if it will just link something containing the README again, with just a bit more metadata like flags.)

@syphar
Copy link
Member

syphar commented Sep 28, 2022

I don't see any issue exposing this in the builds.json output.
I'm happy to review a PR implementing this change.

Mentoring instructions:

  • web::releases::build_list_handler
  • add releases.is_library field to the SQL statement & JSON output, the same way as we read & expose releases.rustdoc_status right now.
  • adapt the tests accordingly
  • no need to show this in the interface.

@syphar syphar added mentor This has instructions for getting started E-easy Effort: Should be easy to implement and would make a good first PR labels Sep 28, 2022
@calebcartwright
Copy link
Member

calebcartwright commented Sep 28, 2022

Just want to add that we'll happily update things on the Shields.io side once this is in place 👍

Actually I misunderstood, thought the response structure was going to be changed, but doesn't sound like that'll be necessary

@Nemo157
Copy link
Member

Nemo157 commented Sep 29, 2022

I think we probably do want to change the structure, add a has_library: bool field to it (the naming is_library in the database is subtly wrong since a package can contain both a library and some binaries). We may supporting documenting binaries in the future which would give build_status: true, has_library: false.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Effort: Should be easy to implement and would make a good first PR mentor This has instructions for getting started
Projects
None yet
Development

No branches or pull requests

4 participants