Repository navigation
Conversation
CLI v2 is deprecated. Point the remaining user guidance at the Codacy Analysis CLI: - Dart Analyzer page: manual setup and GitHub Action use codacy-analysis and codacy/analysis-cli-action@v1 (OD-744, OD-746) - Container scanning and SBOM API pages: upload-sbom / container-scan, matching the in-app CI/CD snippets (OD-742) - 150 KB FAQ: analyze --max-file-size (OD-747) - Configuration file page: codacy-analysis validate-configuration - Analysis CLI page: container-scanning section, third-party SARIF note - Self-hosted: drop the CLI v2 "Cloud only" entry Co-Authored-By: Claude Opus 5.5 <[email protected]>
Up to standards ✅🟢 Issues
|
|
Overall readability score: 54.6 (🟢 +0.1)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
👀 Worth a closer look
Two documentation issues need review in the Dart Analyzer guide: the manual workflow does not explain authentication required for remote configuration and result uploads, and a heading change may break existing deep links. No Codacy quality summary was provided.
Test suggestions
- Build the MkDocs site in strict mode and verify all changed links, anchors, and navigation references.
- Search non-release-note documentation for remaining CLI v2 references.
- Verify the Dart Analyzer manual and GitHub Action examples use the Analysis CLI and upload results correctly.
- Verify container scanning examples cover rolling tags, per-release tags, SBOM uploads, and local scans.
- Verify the new Analysis CLI commands and options are documented consistently across the CLI, FAQ, and configuration pages.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Build the MkDocs site in strict mode and verify all changed links, anchors, and navigation references.
2. Search non-release-note documentation for remaining CLI v2 references.
3. Verify the Dart Analyzer manual and GitHub Action examples use the Analysis CLI and upload results correctly.
4. Verify container scanning examples cover rolling tags, per-release tags, SBOM uploads, and local scans.
5. Verify the new Analysis CLI commands and options are documented consistently across the CLI, FAQ, and configuration pages.
TIP How was this review? Give us feedback
| %} | ||
|
|
||
| ## Important Concepts | ||
| ## Dart SDK and dependencies |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Preserve the existing #important-concepts anchor alongside the new heading so existing deep links continue to work.
TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.
There was a problem hiding this comment.
Dismissing. The old "Important concepts" section described CLI v2's .codacy/codacy.yaml, which no longer applies, so an anchor that lands readers on SDK setup would be misleading. A stale #important-concepts link still opens the page, just at the top. No internal link uses it: mkdocs build --strict passes.
🤖 Generated by /pr-fixup command
|
|
||
| ```bash | ||
| npm i -g @codacy/analysis-cli | ||
| codacy-analysis init --remote <gh|gl|bb> <ORGANIZATION> <REPOSITORY> |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Document the authentication steps required for both remote configuration initialization and result uploads before running these commands.
TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.
There was a problem hiding this comment.
False positive. Authentication is the first step of the shared client-side tool instructions included at the top of this page (client-side-tool-instructions.md, step 1: CODACY_PROJECT_TOKEN or CODACY_API_TOKEN), the same as on the ESLint page. Both init --remote and upload read those variables.
🤖 Generated by /pr-fixup command
Codacy CLI v2 is deprecated. This PR points the remaining user guidance (outside release notes) at the Codacy Analysis CLI and its GitHub Action. Linear: OD-742, OD-744, OD-746, OD-747.
running-dartanalyzer.md, OD-744/OD-746): rewritten to match the ESLint page.--install-dependencies, ordarton PATH, and whydart pub getmust run first.codacy-analysis.codacy/analysis-cli-action@v1.analyzewhere it meantupload.security/container-scanning.md, OD-742):codacy-analysis upload-sbom, with the same rolling and per-release snippets the app shows (codacy-spa PR);upload-sbom;codacy-analysis container-scan.--max-file-sizeunder "Tune the run";validate-configurationtip;--tool).codacy-analysis analyze --max-file-size 1MB, thenupload, instead of the legacy Scala CLI.codacy-analysis validate-configuration.--max-file-sizeandvalidate-configuration(codacy/analysis-cli PR). The FAQ, configuration-file and Analysis CLI pages document them.Out of scope on purpose: the Guardrails JetBrains section (that extension still uses CLI v2), and the legacy-CLI references for aligncheck, deadcode and SpotBugs (only the legacy CLI runs those tools).
👀 Live preview
🚧 To do
mkdocs build --strictpasses;grep -ri "cli-v2\|cli v2"finds nothing outside release notes)🤖 Generated with Claude Code