Skip to main content

Module pr_comment

Module pr_comment 

Source

Structs§

CiIssue
Normalized CodeClimate issue used by CI comment renderers.
CodeClimateIssue
Single CodeClimate-compatible issue inside CodeClimateOutput.
PrCommentEnvelope
Rendered PR comment body plus posting signals for provider adapters.
PrCommentTruncation
Finding-count truncation metadata for a rendered PR comment.
PrDecisionAnnotation
File-anchored annotation inside PrDecisionSurface::annotations.
PrDecisionDetails
Report content and links inside PrDecisionSurface::details.
PrDecisionGate
One quality-gate outcome inside PrDecisionSurface::gates.
PrDecisionSurface
Provider-neutral PR gate decision, consumed by CI integrations to publish a check run or equivalent status surface.
PrDetailsArtifact
Full-findings report artifact backing the PR summary comment’s details link, grouped into per-area sections.
PrDetailsRow
One finding row inside PrDetailsSection::rows.
PrDetailsSection
One findings section inside PrDetailsArtifact::sections.

Enums§

PrCommentLayout
Body layout variant for the sticky PR comment.
PrDecisionAnnotationLevel
Display level for a PrDecisionAnnotation; values mirror GitHub check-run annotation levels.
PrDecisionConclusion
Outcome of the overall decision or a single gate; values mirror GitHub check-run conclusions.
Provider
Supported CI review providers for generated comments.

Constants§

PR_DECISION_SCHEMA
Schema discriminator serialized into PrDecisionSurface::schema.
PR_DETAILS_SCHEMA
Schema discriminator serialized into PrDetailsArtifact::schema.

Functions§

command_title
Human-readable report title for a fallow command name, e.g. dupes maps to “duplication report”.
issues_from_codeclimate
Extract normalized CI issues from a raw CodeClimate JSON array, sorted by severity then location.
render_pr_comment
Render the sticky comment body. conclusion is the gate outcome the caller already computed, folded into the severity-derived verdict by the renderer; None renders the severity-derived verdict alone.
set_workspace_marker_from_list
Set the workspace marker from a --workspace selection list.