Module: StillActive::DiffMarkdownHelper

Extended by:
DiffMarkdownHelper
Included in:
DiffMarkdownHelper
Defined in:
lib/helpers/diff_markdown_helper.rb

Overview

Renders a StillActive::Diff::Result as PR-comment-friendly markdown. Section taxonomy mirrors GitHub’s dependency-review-action so reviewers already know where to look: Regressions / Added / Removed / Bumps / Signal changes / Ruby. Empty sections are skipped.

Constant Summary collapse

BUMP_KIND_LABELS =
{
  closed_vulns: "closed vulns",
  introduced_vulns: "INTRODUCED vulns",
  fresher: "fresher",
  older_relative: "older relative to latest",
  neutral: nil,
  unknown: nil,
}.freeze

Instance Method Summary collapse

Instance Method Details

#render(diff) ⇒ Object



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/helpers/diff_markdown_helper.rb', line 20

def render(diff)
  sections = [
    "## still_active diff",
    "",
    summary_line(diff),
    "",
    regressions_section(diff.regressions),
    added_section(diff.added),
    removed_section(diff.removed),
    bumps_section(diff.bumped),
    signal_changes_section(diff.signal_changes),
    ruby_section(diff.ruby),
  ].reject(&:empty?)

  "#{sections.join("\n")}\n"
end