docs: update documentation links to commit-check.com - #518
Conversation
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 53 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThe pull request replaces the old documentation host with ChangesDocumentation URL update
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
📝 Generate docstrings
🧪 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #518 +/- ##
==========================================
+ Coverage 97.34% 97.43% +0.08%
==========================================
Files 12 12
Lines 1207 1207
==========================================
+ Hits 1175 1176 +1
+ Misses 32 31 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
commit_check/rules_catalog.py (1)
24-24: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAssert the migrated host in the catalog test.
tests/rules_catalog_test.pyLines 63-66 derives the expected URL fromRULES_DOCS_URL. The test therefore passes if this change accidentally reverts to the old host. Add an explicit assertion for the new host and/rules/path.Suggested test assertion
assert entry.docs_url == f"{RULES_DOCS_URL}`#cc003`" + assert entry.docs_url == "https://commit-check.com/rules/#cc003"🤖 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 `@commit_check/rules_catalog.py` at line 24, Update the catalog test covering RULES_DOCS_URL to explicitly assert the migrated host and the “/rules/” path, rather than deriving the expected value solely from RULES_DOCS_URL. Preserve the existing catalog validation while ensuring the test fails if the URL reverts to the old host.
🤖 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 426: Update the user-facing sentence in the README around the example
documentation link from “More examples see” to “For more examples, see,”
preserving the existing link and punctuation.
---
Nitpick comments:
In `@commit_check/rules_catalog.py`:
- Line 24: Update the catalog test covering RULES_DOCS_URL to explicitly assert
the migrated host and the “/rules/” path, rather than deriving the expected
value solely from RULES_DOCS_URL. Preserve the existing catalog validation while
ensuring the test fails if the URL reverts to the old host.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 9b882ccf-92f1-480e-853b-833bbe00f2bb
📒 Files selected for processing (3)
README.mdcommit_check/rules_catalog.pypyproject.toml
5900147 to
bc96b74
Compare
The documentation moved to its own repository and is served from the apex domain alongside the landing page and the blog. RULES_DOCS_URL matters most here: it is embedded in every failure message the tool prints, so it has to be correct before the next release makes it permanent. A test now pins the base URL rather than deriving expectations from it, so a wrong or reverted value fails instead of being followed. The CLI reference page is gone, and the flags it listed are documented alongside the settings that control them, so those links now point at the configuration page.
8698550 to
7430d18
Compare
|
Merging this PR will improve performance by ×12
|
| Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|
| ⚡ | test_empty_message_passes |
28 ms | 2.3 ms | ×12 |
| 🆕 | test_docs_url_points_at_the_published_site |
N/A | 242.4 µs | N/A |
Tip
Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.
Comparing docs/point-links-at-commit-check-com (7430d18) with main (6751073)
Footnotes
-
116 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
The documentation moved to commit-check/commit-check.com, where it is served from the apex domain alongside the landing page and the blog.
This is the URL-only half of the migration. It is safe to merge before the new site is live, because
docs.commit-check.comkeeps serving until it is retired.Changes
commit_check/rules_catalog.pyRULES_DOCS_URL→https://commit-check.com/rules/pyproject.tomldocumentationproject URLREADME.md.htmlURLsRULES_DOCS_URLis the one that matters. It is embedded in every failure message the tool prints, so it has to be right before the next release makes it permanent. It has not shipped to PyPI yet, which is the only reason changing it is still free.The CLI reference page no longer exists — the flags it listed are documented alongside the settings that control them — so
cli_args.htmlnow points at the configuration page.Not in this PR
Removing
docs/,mkdocs.yml,netlify.toml, thedocsCI job and the six documentation-consistency tests. Doing that before the new site has DNS and Pages configured would leave a window with no documentation on either domain, so it wants a separate change oncecommit-check.comis verified live.Verification
460 passed, 1 failed— the failure istest_load_config_file_permission_error, which usesos.chmod(0o000)and cannot fail as root; it is unrelated to this change and fails the same way onmain.Summary by CodeRabbit
commit-check.comdomain.