Skip to content

docs: add OSSF and crate badges to mdbook#92

Merged
mergify[bot] merged 1 commit intomainfrom
docs/add-badges-to-mdbook
Feb 16, 2026
Merged

docs: add OSSF and crate badges to mdbook#92
mergify[bot] merged 1 commit intomainfrom
docs/add-badges-to-mdbook

Conversation

@unclesp1d3r
Copy link
Member

Summary

  • Add OSSF Best Practices, OpenSSF Scorecard, crates.io, and license badges to the mdbook introduction page
  • OSSF Best Practices requires the badge on the project website (evilbitlabs.io/libmagic-rs/)

Test plan

  • Verify badges render correctly in mdbook (mdbook serve)
  • Confirm badge links resolve to correct targets

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>
Copilot AI review requested due to automatic review settings February 16, 2026 02:30
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Feb 16, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


Summary by CodeRabbit

  • Documentation
    • Added OpenSSF Best Practices, OpenSSF Scorecard, Crates.io, and License badges to the introduction documentation.

Walkthrough

Added 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

Cohort / File(s) Summary
Documentation Badges
docs/src/introduction.md
Added four status/certification badges at the beginning of the introduction document (+5 lines).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Four bright badges now adorn the way,
Shields of trust for all to display,
Best Practices, Scores, and Licenses true,
Our introduction shines in vibrant hue! ✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding OSSF and crate badges to the mdbook documentation.
Description check ✅ Passed The description clearly relates to the changeset, providing specific badge details and a test plan aligned with the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-badges-to-mdbook

Comment @coderabbitai help to get the list of available commands and usage tips.

@mergify
Copy link

mergify bot commented Feb 16, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 CI must pass

Wonderful, this rule succeeded.

All CI checks must pass. This protection prevents manual merges that bypass the merge queue.

  • check-success = coverage
  • check-success = quality
  • check-success = test
  • check-success = test-cross-platform (macos-latest, macOS)
  • check-success = test-cross-platform (ubuntu-22.04, Linux)
  • check-success = test-cross-platform (ubuntu-latest, Linux)
  • check-success = test-cross-platform (windows-latest, Windows)

🟢 Do not merge outdated PRs

Wonderful, this rule succeeded.

Make sure PRs are within 10 commits of the base branch before merging

  • #commits-behind <= 10

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Feb 16, 2026
@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@mergify
Copy link

mergify bot commented Feb 16, 2026

🧪 CI Insights

Here's what we observed from your CI run for 6e76159.

🟢 All jobs passed!

But CI Insights is watching 👀

@unclesp1d3r unclesp1d3r self-assigned this Feb 16, 2026
@unclesp1d3r unclesp1d3r added the lgtm Approved for the merge queue label Feb 16, 2026
@mergify mergify bot added the queued label Feb 16, 2026
mergify bot added a commit that referenced this pull request Feb 16, 2026
@mergify
Copy link

mergify bot commented Feb 16, 2026

Merge Queue Status

Rule: default


This pull request spent 4 minutes 15 seconds in the queue, including 4 minutes 6 seconds running CI.

Required conditions to merge
  • check-success = coverage
  • check-success = quality
  • check-success = test
  • check-success = test-cross-platform (macos-latest, macOS)
  • check-success = test-cross-platform (ubuntu-22.04, Linux)
  • check-success = test-cross-platform (ubuntu-latest, Linux)
  • check-success = test-cross-platform (windows-latest, Windows)
  • all of [🛡 Merge Protections rule CI must pass]:
    • check-success = coverage
    • check-success = quality
    • check-success = test
    • check-success = test-cross-platform (macos-latest, macOS)
    • check-success = test-cross-platform (ubuntu-22.04, Linux)
    • check-success = test-cross-platform (ubuntu-latest, Linux)
    • check-success = test-cross-platform (windows-latest, Windows)
  • all of [🛡 Merge Protections rule Do not merge outdated PRs]:
  • any of [🛡 GitHub repository ruleset rule main]:
    • check-success = DCO
    • check-neutral = DCO
    • check-skipped = DCO
  • any of [🛡 GitHub repository ruleset rule main]:
    • check-neutral = Mergify Merge Protections
    • check-skipped = Mergify Merge Protections
    • check-success = Mergify Merge Protections

@mergify mergify bot merged commit 532b754 into main Feb 16, 2026
34 checks passed
@mergify mergify bot deleted the docs/add-badges-to-mdbook branch February 16, 2026 02:55
@mergify mergify bot removed the queued label Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm Approved for the merge queue size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments