Skip to content

feat: Add shields.io endpoint badge API #261

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

Merged
merged 1 commit into from
May 14, 2025
Merged

Conversation

DCjanus
Copy link
Member

@DCjanus DCjanus commented May 13, 2025

This Pull Request re-implements the feature originally proposed in PR #122 by @dnaka91.

Due to the time passed and subsequent changes in the codebase, the original PR became difficult to merge. This new PR builds upon that foundation to bring the feature to fruition.

Many thanks to @dnaka91 for their excellent initial work and for identifying this valuable approach. Without their pioneering efforts, we wouldn't have discovered this effective way to integrate with shields.io.

@DCjanus DCjanus requested a review from robjtede May 13, 2025 19:34
@DCjanus
Copy link
Member Author

DCjanus commented May 13, 2025

This PR also helps address the desire for customizable badge styles, as raised in issue #245.

By exposing a shields.io compatible endpoint, this change will allow users to generate badges with their preferred styling. For example, a URL like https://img.shields.io/endpoint?url=https%3A%2F%2Fdeps.rs%2Fcrate%2Fsyn%2Flatest%2Fshield.json&style=for-the-badge could be used.

(Note: The example URL will only become active once this PR is merged and the endpoint is deployed.)

Furthermore, this PR lays the groundwork for potential native integration with shields.io in the future, which could lead to even simpler badge URLs.

@DCjanus DCjanus requested a review from Feliix42 May 14, 2025 07:47
Copy link
Member

@robjtede robjtede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice 👍🏻

@DCjanus DCjanus merged commit e0fdb1e into deps-rs:main May 14, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants