Skip to content

docs: document affected functions for vulnerable dependency findings OD-297 - #2716

Merged
joanasteodoro merged 6 commits into
masterfrom
docs-affected-functions-od-297
Jul 31, 2026
Merged

docs: document affected functions for vulnerable dependency findings OD-297#2716
joanasteodoro merged 6 commits into
masterfrom
docs-affected-functions-od-297

Conversation

@claudiacodacy

@claudiacodacy claudiacodacy commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new "affected functions" capability shipping under the Expose Advisory entrypoint function project (OD-297): for vulnerable dependency findings linked to an advisory (CVE or GHSA) with known affected functions, Codacy now shows exactly which functions are affected and lets you generate a coding-agent prompt to check reachability in your own code.

  • Adds an Affected functions subsection to Security and risk management findings, alongside the existing Dependency chain / Severity changes sections.
  • Adds a matching Check affected functions on vulnerable dependencies subsection to the Codacy Cloud CLI docs, covering issues/issue/findings/finding/pull-request.

Notes for reviewers

  • Written to describe the finished feature (GHSA support, tab renamed to Advisory Information, full CLI coverage) — some of this is still in flight as of writing:
    • GHSA-sourced advisories: codacy-spa#3072 (In Review) — renames the "CVE Record" tab to "Advisory Information" and adds GHSA support alongside the existing CVE support.
    • The web UI feature is still behind the tempAffectedFunctions flag and an in-app announcement tooltip (OD-315) hasn't shipped yet.
    • Please hold merge until GHSA support (OD-403) lands and the feature flag is lifted, so the docs match what users actually see.
  • Missing screenshot: added a placeholder image reference (images/security-risk-management-affected-functions.png) with a TODO comment in managing-security-and-risk.md — needs a real screenshot before merging.
  • The in-app "Check if you're affected" modal already has a Learn more link wired up but pointing at an empty URL (articleUrl="" in AffectedFunctionsModal.tsx, codacy-spa#3071). Once this page is live, it should point to organizations/managing-security-and-risk/#affected-functions.

Test plan

  • Add the missing screenshot and remove the TODO comment
  • Confirm final UI copy/tab name once OD-403 merges
  • mkdocs build locally to confirm no broken links/build warnings

Adds an "Affected functions" section to Security and risk management
findings, and a matching section to the Codacy Cloud CLI docs covering
issues/issue/findings/finding/pull-request output.

Related: OD-297
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.92 (🔴 -0.02)

File Readability
managing-security-and-risk.md 57.63 (🔴 -0.74)
index.md 59.44 (🔴 -4.31)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
managing-security-and-risk.md 57.63 36.28 9.96 13.1 12.87 6.47
  🔴 -0.74 🔴 -0.41 🔴 -0.16 🔴 -0.2 🔴 -0.05 🔴 -0.01
index.md 59.44 40.75 9.9 10.9 12.17 7.47
  🔴 -4.31 🔴 -2.13 🔴 -0.87 🔴 -1.2 🔴 -0.88 🟢 +0.16

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.92 42.85 10.93 12.34 12.29 8.04
  🔴 -0.02 🔴 -0.01 🟢 +0 🔴 -0.01 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

The placeholder screenshot referenced a file that doesn't exist yet,
which mkdocs' strict mode treats as a build-breaking warning. Move the
image tag inside the TODO comment so it's added back (uncommented)
once the real screenshot lands.
@github-actions
github-actions Bot temporarily deployed to Netlify July 30, 2026 10:34 Inactive
@claudiacodacy claudiacodacy changed the title docs: document affected functions for vulnerable dependency findings docs: document affected functions for vulnerable dependency findings OD-297 Jul 30, 2026
@claudiacodacy
claudiacodacy marked this pull request as ready for review July 30, 2026 10:34
@claudiacodacy
claudiacodacy requested a review from a team as a code owner July 30, 2026 10:34
@github-actions
github-actions Bot temporarily deployed to Netlify July 30, 2026 10:36 Inactive

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

The pull request successfully updates the documentation for the new 'affected functions' SCA feature across the web UI and CLI. While Codacy results are up to standards, there is a significant blocker: the screenshot for the web UI is currently a placeholder, which fails a key acceptance criterion.

Additionally, there is a gap in the CLI documentation regarding specific command examples for 'findings', 'finding', and 'pull-request'. The PR also documents UI changes that have not yet been released to production, and a 'Learn more' link in the application will require post-deployment validation once this documentation is live.

About this PR

  • This PR documents features currently in development for the web application (codacy-spa). Ensure the documentation release is synchronized with the application deployment to avoid user confusion.
  • Note that the 'Learn more' link in the web UI currently points to an empty URL; this must be verified once these docs are published.

Test suggestions

  • Found recommended test scenario: Documentation reflects the 'Advisory Information' tab rename
  • Found recommended test scenario: CLI documentation provides examples for both list (summary) and detail (full block) views
  • Found recommended test scenario: Documentation explains how to use the AI prompt for reachability checks
  • Missing recommended test scenario: CLI documentation includes specific command examples for 'findings', 'finding', and 'pull-request'
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Missing recommended test scenario: CLI documentation includes specific command examples for 'findings', 'finding', and 'pull-request'

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

Comment thread docs/organizations/managing-security-and-risk.md
Comment thread docs/codacy-cloud-cli/index.md
Points to the codacy-cloud-cli skill instead of raw CLI/jq commands, so
the workflow stays in sync with the skill's own instructions rather than
duplicating command syntax in two places.
@github-actions
github-actions Bot temporarily deployed to Netlify July 31, 2026 11:05 Inactive
alerizzo pushed a commit to codacy/codacy-skills that referenced this pull request Jul 31, 2026
…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)
@joanasteodoro
joanasteodoro merged commit 1aa49e9 into master Jul 31, 2026
5 checks passed
@joanasteodoro
joanasteodoro deleted the docs-affected-functions-od-297 branch July 31, 2026 13:22
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