Skip to content

feat(codacy-skills): document affected functions for SCA issues/findings - #7

Merged
alerizzo merged 2 commits into
codacy:masterfrom
claudiacodacy:docs-cli-affected-functions
Jul 31, 2026
Merged

feat(codacy-skills): document affected functions for SCA issues/findings#7
alerizzo merged 2 commits into
codacy:masterfrom
claudiacodacy:docs-cli-affected-functions

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Summary

issues/issue/findings/finding in the Codacy Cloud CLI now surface the affected functions of a linked advisory (CVE or GHSA) when Codacy has identified them (codacy-cloud-cli#34, merged, part of OD-296). This updates the codacy-cloud-cli skill so an agent knows this data exists and how to act on it.

  • Notes the compact Vulnerable functions: fn1, fn2 (+N more) line and the full Vulnerable Functions (<advisoryId>) detail block for both the Issues and Security findings sections.
  • Adds a "Check whether a vulnerable dependency is actually reachable" entry to Common workflows, since this is the same reachability check the product's own "Check if you're affected" UI feature asks users to run with a coding agent.
  • Bumped version to 1.6.0 per CONTRIBUTING.md.

Companion docs-site PR: codacy/docs#2716 (still draft — pending GHSA support and feature-flag removal on the web UI side; the CLI feature itself is already merged and unaffected by that).

…ndings

issues/issue/findings/finding now surface the affected functions of a
linked advisory (CVE or GHSA), where known. Document the compact and
detail-view formats and add a workflow for checking reachability
before upgrading a dependency or ignoring a finding as NotExploitable.

Related: OD-296, OD-297 (codacy/docs#2716)

Ignore reasons: `AcceptedUse` (default) | `FalsePositive` | `NotExploitable` | `TestCode` | `ExternalCode`

**Affected functions:** for SCA issues linked to an advisory (CVE or GHSA) with known affected functions, `issues`/`issue` show them alongside the regular output — a compact `Vulnerable functions: fn1, fn2 (+N more)` line on list/card views, and a full `Vulnerable Functions (<advisoryId>)` block with published date on `codacy issue` detail views. Always included in `--output json` when present. Use this to tell a user exactly which functions a vulnerability affects, so they (or their coding agent) can check whether their code actually calls them before deciding to upgrade the dependency or ignore the finding as `NotExploitable`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Affected functions:** for SCA issues linked to an advisory (CVE or GHSA) with known affected functions, `issues`/`issue` show them alongside the regular output — a compact `Vulnerable functions: fn1, fn2 (+N more)` line on list/card views, and a full `Vulnerable Functions (<advisoryId>)` block with published date on `codacy issue` detail views. Always included in `--output json` when present. Use this to tell a user exactly which functions a vulnerability affects, so they (or their coding agent) can check whether their code actually calls them before deciding to upgrade the dependency or ignore the finding as `NotExploitable`.
**Affected functions:** for SCA issues linked to an advisory (CVE or GHSA) with known affected functions, `issues` and `findings` show them alongside the regular output — a compact `Vulnerable functions: fn1, fn2 (+N more)` line on list/card views, and a full `Vulnerable Functions (<advisoryId>)` block with published date on `codacy issue` and `codacy finding` detail views. Always included in `--output json` when present. Use this to tell a user exactly which functions a vulnerability affects, so they (or their coding agent) can check whether their code actually calls them before deciding to upgrade the dependency or ignore the finding as `NotExploitable`.

@claudiacodacy

Copy link
Copy Markdown
Contributor Author

Validated the documented output against live data (codacy-cloud-cli 1.7.0, org `codacy`), not just the source PRs:

Card views — `codacy issues gh codacy codacy-remark-lint --tools trivy`:
```
Vulnerable functions: matchOne, minimatch
Vulnerable functions: v3, v5, v6 (+3 more)
```

Detail views — `codacy issue gh codacy codacy-remark-lint 131358696592` and `codacy finding gh codacy 86fb4b06-beca-4f88-b4d4-3ca6ee5d3872` (no linked issue) both render:
```
Vulnerable Functions (CVE-2024-4067)
Published: 2024-05-13

• micromatch.braces
```

Also confirmed `--ignore-reason` accepts `NotExploitable` via `codacy issue --help`.

All matches what's now documented in this PR. No discrepancies found.

zhamborova
zhamborova previously approved these changes Jul 30, 2026
@claudiacodacy claudiacodacy changed the title feat(codacy-cloud-cli): document affected functions for SCA issues/findings feat(codacy-skills): document affected functions for SCA issues/findings Jul 30, 2026
…scale

Adds a "Common workflows" entry for checking affected functions across
one or multiple repos in a single pass, alongside the existing
single-finding reachability check. Bumps skill version to 1.6.1.
@alerizzo
alerizzo merged commit 41036bc into codacy:master Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants