ENH: Adding badges to README.md for project health overview - #103
Conversation
WalkthroughChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a set of project “health” and metadata badges at the top of README.md to give readers an at-a-glance view of CI status, docs builds, nightly health, coverage, and key tooling.
Changes:
- Added GitHub Actions workflow badges for CI, documentation, and nightly health.
- Added project metadata/tooling badges (PyPI, supported Python versions, license, Ruff, mypy, pre-commit).
- Added Codecov coverage badge.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 5: Replace the Nightly Health badge’s endpoint URL and target with the
existing GitHub Actions workflow badge/source, so the README directly reflects
the nightly-health workflow status instead of the nightly-status Pages endpoint.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| [](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/ci.yml) | ||
| [](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/docs.yml) | ||
| [](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/nightly-health.yml) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "README line:"
sed -n '1,20p' README.md 2>/dev/null || true
echo
echo "Relevant workflow:"
if [ -f .github/workflows/nightly-health.yml ]; then
sed -n '1,220p' .github/workflows/nightly-health.yml
else
echo ".github/workflows/nightly-health.yml not found"
fi
echo
echo "Endpoint status response (if reachable):"
python3 - <<'PY'
import json, urllib.request, urllib.error
url = "https://project-monai.github.io/physiotwin4d/status.json"
try:
with urllib.request.urlopen(url, timeout=20) as r:
print("status", r.status)
text = r.read().decode("utf-8", "replace")
print("body", text[:2000])
try:
data = json.loads(text)
print("parsed_message", data.get("message"))
print("parsed_color", data.get("color"))
except Exception as e:
print("parse_error", repr(e))
except Exception as e:
print("error", repr(e))
PYRepository: Project-MONAI/physiotwin4d
Length of output: 12076
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Build dashboard script:"
if [ -f .github/scripts/build_dashboard.py ]; then
sed -n '1,240p' .github/scripts/build_dashboard.py
else
echo ".github/scripts/build_dashboard.py not found"
fi
echo
echo "Upload dashboard artifact steps:"
rg -n -C 6 "Upload dashboard|upload-artifact|status\.json|project-monai\.github\." README.md .github/workflows/nightly-health.yml .github/scripts/build_dashboard.py || trueRepository: Project-MONAI/physiotwin4d
Length of output: 22793
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "docs.yml deployment status handling:"
if [ -f .github/workflows/docs.yml ]; then
sed -n '1,260p' .github/workflows/docs.yml
else
echo ".github/workflows/docs.yml not found"
fi
echo
echo "Docs workflow references for status.json and Pages output:"
rg -n -C 6 "status\.json|pages|upload-pages-artifact|ghp-*|nightly-status|continues-on-error|continue-on-error" .github/workflows/docs.yml README.md || trueRepository: Project-MONAI/physiotwin4d
Length of output: 9507
Use the GitHub Actions status badge for nightly health.
The README links to the nightly-status Pages endpoint, but the direct endpoint source returns a self-signed certificate error in the sandbox. The workflow already documents the Actions badge as the live pass/fail README indicator, and the generated endpoint uses unknown/critical when test results are unavailable. Use the Actions badge instead of the endpoint link.
Proposed change
-[](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/nightly-health.yml)
+[](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/nightly-health.yml)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/nightly-health.yml) | |
| [](https://github.com/Project-MONAI/physiotwin4d/actions/workflows/nightly-health.yml) |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 5, Replace the Nightly Health badge’s endpoint URL and
target with the existing GitHub Actions workflow badge/source, so the README
directly reflects the nightly-health workflow status instead of the
nightly-status Pages endpoint.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #103 +/- ##
==========================================
- Coverage 35.99% 35.40% -0.60%
==========================================
Files 58 63 +5
Lines 7292 8203 +911
==========================================
+ Hits 2625 2904 +279
- Misses 4667 5299 +632
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit