Skip to content

Add "Maintenance Status" badge API #2438

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
Turbo87 opened this issue Apr 17, 2020 · 0 comments
Closed

Add "Maintenance Status" badge API #2438

Turbo87 opened this issue Apr 17, 2020 · 0 comments
Labels
A-backend ⚙️ C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works

Comments

@Turbo87
Copy link
Member

Turbo87 commented Apr 17, 2020

Related to #2436 and #2437, we want to offer crate owners the option to add a badge to their README files that reflects the current maintenance status.

We currently use https://shields.io/ to display the maintenance status badge and the service seems stable enough for now to keep using it. I would propose adding an API endpoint that reads the maintenance status for the selected crate from the API, and then redirects to the corresponding shields.io URL like:

Maintenance Status
https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg
@Turbo87 Turbo87 added the A-API label Apr 17, 2020
@Turbo87 Turbo87 mentioned this issue Apr 18, 2020
Closed
@Turbo87 Turbo87 added the C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works label May 12, 2020
@ehuss ehuss mentioned this issue Sep 23, 2020
Merged
bors added a commit to rust-lang/cargo that referenced this issue Sep 23, 2020
@bors
Auto merge of #8727 - ehuss:badges, r=alexcrichton
4e6fa34 
Remove some badges documentation.

Badges have been removed from crates.io, so this updates the documentation. I don't think Cargo should manage a schema for the different services, and since crates.io isn't using these, I think it is mostly a dead feature. I left the `maintenance` field, because that might still have some meaning in the future.

More details:
* Removal from crates.io: rust-lang/crates.io#2436 rust-lang/crates.io#2440
* Solicited feedback for this change: https://internals.rust-lang.org/t/cargo-badges/12982
* Potential future support of `maintenance` status: rust-lang/crates.io#2437 rust-lang/crates.io#2438 rust-lang/crates.io#2439. It's not clear, if crates.io manages the status in the database, the motivation for putting it in `Cargo.toml` is probably pretty small.
@ehuss ehuss mentioned this issue Sep 28, 2020
Closed
@Turbo87 Turbo87 closed this as completed Nov 10, 2021
@dtolnay dtolnay mentioned this issue Dec 9, 2024
Merged
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
A-backend ⚙️ C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Implement GET /crates/:crate_id/maintenance.svg endpoint Turbo87/crates.io
1 participant
@Turbo87