Repository navigation
docs: replace Codacy CLI v2 with the Analysis CLI [OD-742] [OD-744] [OD-746] [OD-747] - #2821
Merged
Merged
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 <noreply@anthropic.com>
Contributor
Up to standards ✅🟢 Issues
|
Contributor
|
Overall readability score: 54.64 (🟢 +0.1)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Contributor
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
joanasteodoro
approved these changes
Nov 10, 2026
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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