Add repository coverage status page - #2743
Conversation
|
Overall readability score: 53.9 (🟢 +0.05)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
This documentation update follows the required structural layout and passes automated quality checks, but it contains technical inaccuracies and alignment risks. The definitions provided for 'Waiting for coverage' and 'Stopped receiving coverage' are inaccurate as they rely on the historical activity of the default branch rather than a single 'most recent commit.' There is also a conflict with existing documentation in 'organization-overview.md' and the inclusion of UI features that have not yet been released. These issues should be addressed to ensure the documentation is accurate and consistent before being merged.
About this PR
- The documentation refers to UI elements (status banners and filters) that are currently unreleased. Consider adding a 'Beta' disclaimer or delaying the release of this page to align with the product launch to avoid user confusion.
- The coverage status definitions introduced here contradict existing documentation in 'organizations/reporting/organization-overview.md'. Please ensure these pages are synchronized to provide consistent information about how metrics are calculated.
Test suggestions
- Verify that the new 'Repository coverage status' page is correctly registered in mkdocs.yml and appears in the site navigation.\n- [ ] Verify that all internal links to 'coverage.md', 'coverage-reporter/index.md', and the FAQ page resolve correctly.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that the new 'Repository coverage status' page is correctly registered in mkdocs.yml and appears in the site navigation.\n- [ ] Verify that all internal links to 'coverage.md', 'coverage-reporter/index.md', and the FAQ page resolve correctly.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| @@ -0,0 +1,23 @@ | |||
| # Repository coverage status | |||
|
|
|||
| Codacy classifies each repository's coverage into one of four statuses, based on whether the most recent commit on the default branch has coverage data. | |||
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: The status is determined by the coverage history of the default branch rather than just the single most recent commit.\n\nsuggestion\nCodacy classifies each repository's coverage into one of four statuses based on the coverage history of its default branch.\n
Summary
No coverage,Up to date,Waiting for coverage,Stopped receiving coverage.mkdocs.ymlnav under Repositories on Codacy, right after Coverage page.Note for reviewers
organizations/reporting/organization-overview.mdcurrently defines "Repositories reporting coverage" as "repositories with coverage data from the latest merged pull request" — the oldmetrics-adaptermechanism. This new page documents the newer engine-driven coverage-status state machine, which isn't wired into that metric yet (migration is OD-50 / OD-48, both still in Linear backlog). The two pages describe different mechanisms for the same underlying question and aren't reconciled in this PR — flagging it for your call on whether/how to align them, rather than resolving it unilaterally.Related: none of the UI-facing pieces that would let a user actually see this status (the "waiting for coverage" banner, gate warnings, repository list filter) have shipped yet either (OD-47, OD-49, OD-51). The page is scoped to the status definitions only — no claims about where it surfaces in the product.
Checks run
mkdocs build --strict— passes (only pre-existing, unrelated warnings)nav:entry confirmed by eyerepositories/coverage.md,coverage-reporter/index.md,faq/code-analysis/why-does-codacy-show-unexpected-coverage-changes.md)Test plan