Skip to content

docs: expand proactive SCA section — Trivy prerequisite and setup paths#2690

Merged
claudiacodacy merged 9 commits into
masterfrom
docs-update-proactive-sca-setup-documentation-od-139
Jun 22, 2026
Merged

docs: expand proactive SCA section — Trivy prerequisite and setup paths#2690
claudiacodacy merged 9 commits into
masterfrom
docs-update-proactive-sca-setup-documentation-od-139

Conversation

@claudiacodacy

@claudiacodacy claudiacodacy commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the single-line Trivy note in the SCA findings section with a full explanation of how proactive SCA nightly scans work
  • Makes Trivy an explicit hard prerequisite (tool + vulnerability patterns — both required)
  • Documents both setup paths: via coding standard (recommended) and per-repo
  • Adds a clear silent-failure warning: enabling the tool alone is not sufficient; missing patterns → scans run but produce nothing, Dependency Explorer shows no data
  • Adds a new H4 subsection with anchor #proactive-sca-requirements so Phase 2 in-product CTAs (OD-143, OD-144) can deep-link directly to the prerequisite content

Context

Part of the Enable Trivy when enabling proactive SCA project. This is the Phase 1 prerequisite — every in-product CTA planned for Phase 2 links here.

Linear: OD-139 | Jira: ODIN-106
Analysis doc: Proactive SCA & Trivy Enablement — Problem Analysis & Options

Test plan

  • Verify #proactive-sca-requirements anchor resolves correctly on the rendered page
  • Verify #dependencies-list and #item-list anchor links work within the page
  • Verify relative links to using-coding-standards.md and ../repositories-configure/configuring-code-patterns.md resolve
  • Verify the Knock link (start-chat.com/slack/codacy/rmbTzb) opens the chat correctly

🤖 Generated with Claude Code

… and deep-link anchor

Replaces the single-line Trivy note with a full explanation of how
proactive SCA nightly scans work, what's required (Trivy tool + vulnerability
patterns), both setup paths (coding standard / per-repo), and the silent
failure case when only the tool is enabled.

Adds a new H4 subsection with anchor #proactive-sca-requirements so Phase 2
CTAs (Dependency Explorer empty state OD-143, partial coverage banner OD-144)
can deep-link directly to the prerequisite content.

Closes OD-139

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claudiacodacy claudiacodacy requested a review from a team as a code owner June 22, 2026 15:01
@codacy-production

codacy-production Bot commented Jun 22, 2026

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.

@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:02 Inactive

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the documentation regarding how Codacy manages findings detected during Software Composition Analysis (SCA). It clarifies the behavior of proactive SCA nightly scans, outlines the specific Trivy requirements needed for these scans to run successfully, and provides instructions on enabling Trivy either via coding standards or per repository. The feedback suggests a minor grammatical improvement to hyphenate 'Business-tier' when used as a compound modifier.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/organizations/managing-security-and-risk.md Outdated
@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 54.23 (🟢 +0)

File Readability
managing-security-and-risk.md 58.71 (🟢 +0.68)
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 58.71 36.89 9.72 12.8 12.82 6.45
  🟢 +0.68 🟢 +0.3 🟢 +0.19 🟢 +0.1 🟢 +0 🟢 +0.05

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.23 43.17 10.9 12.3 12.24 8.01
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +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 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 documentation expansion for Proactive SCA accurately captures the mandatory Trivy prerequisites and setup paths, meeting Codacy quality standards. However, a significant discrepancy exists between the implementation and the technical requirements: the identifier for low-severity vulnerabilities is incorrectly documented as 'minor', which is not a valid pattern ID. Additionally, several internal and external links, along with the deep-linking anchor, require manual verification to ensure navigational integrity. These issues should be addressed to prevent configuration failures for users following these instructions.

Test suggestions

  • Verify the '#proactive-sca-requirements' anchor is present and correctly formatted for deep-linking.\n- [ ] Verify relative links to 'using-coding-standards.md' and repository code patterns documentation resolve correctly.\n- [ ] Verify internal page links to '#dependencies-list' and '#item-list' resolve to valid sections within the same document.\n- [ ] Verify the external support chat link is valid and points to the correct destination.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the '#proactive-sca-requirements' anchor is present and correctly formatted for deep-linking.\n- [ ] Verify relative links to 'using-coding-standards.md' and repository code patterns documentation resolve correctly.\n- [ ] Verify internal page links to '#dependencies-list' and '#item-list' resolve to valid sections within the same document.\n- [ ] Verify the external support chat link is valid and points to the correct destination.

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 Outdated
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:06 Inactive
…cies cross-link

- Lead with what SCA findings are (dependency vulnerabilities) before
  explaining the daily re-scan feature
- Use "daily re-scans" (matches pricing page "Daily SCA and Malicious
  Package re-scans") and drop "nightly" / "every evening" inconsistency
- Remove inaccurate closing sentence — nightly scans always run for
  SCA-enabled orgs; enabling Trivy makes them produce results, not start
- Add cross-reference in the Dependencies section pointing to
  #proactive-sca-requirements so there's a path in both directions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:11 Inactive
… of file)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:15 Inactive
Removes the orange Important admonition that was breaking the reading
flow. The business-tier note is now a single inline sentence at the end
of the daily re-scans paragraph. Pattern IDs moved to sub-bullets for
readability.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:25 Inactive
…indings subsection

SCA findings behave identically to other git findings — no separate
lifecycle documentation needed. The unique part (daily re-scans + Trivy
requirements) belongs with Dependencies, where an admin with an empty
tab will look for help.

- SCA findings subsection: collapsed to 2 sentences + link to
  #proactive-sca-requirements
- Trivy requirements block: moved from H4 under Findings to H3 under
  Dependencies, anchor preserved for Phase 2 CTA deep-links (OD-143,
  OD-144)
- Dependencies upgrade CTA: updated to use Knock link for consistency

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:30 Inactive
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to Netlify June 22, 2026 15:35 Inactive
@claudiacodacy claudiacodacy merged commit 3a0e934 into master Jun 22, 2026
5 checks passed
@claudiacodacy claudiacodacy deleted the docs-update-proactive-sca-setup-documentation-od-139 branch June 22, 2026 15:41
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.

2 participants