docs: add OSSF and crate badges to mdbook#92
Conversation
OSSF Best Practices requires the badge on the project website. The mdbook at evilbitlabs.io/libmagic-rs/ serves as that site. Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
|
No actionable comments were generated in the recent review. 🎉 Summary by CodeRabbit
WalkthroughAdded four documentation badges (OpenSSF Best Practices, OpenSSF Scorecard, Crates.io, and License) to the top of the introduction file. No functional logic, error handling, or control flow changes—purely documentation content augmentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 CI must passWonderful, this rule succeeded.All CI checks must pass. This protection prevents manual merges that bypass the merge queue.
🟢 Do not merge outdated PRsWonderful, this rule succeeded.Make sure PRs are within 10 commits of the base branch before merging
|
There was a problem hiding this comment.
Pull request overview
This PR adds OSSF and crate badges to the mdbook documentation to meet OSSF Best Practices compliance requirements. The badges provide visual indicators of the project's security practices, code quality, and availability on crates.io.
Changes:
- Add four badges (OpenSSF Best Practices, OpenSSF Scorecard, Crates.io version, and License) to the mdbook introduction page
- Badges match those already present in README.md for consistency
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
🧪 CI InsightsHere's what we observed from your CI run for 6e76159. 🟢 All jobs passed!But CI Insights is watching 👀 |
Merge Queue StatusRule:
This pull request spent 4 minutes 15 seconds in the queue, including 4 minutes 6 seconds running CI. Required conditions to merge
|
Summary
Test plan
mdbook serve)