Skip to content

Review-friendly summary output for GitOps workflows #128

Description

@hardbyte

Background

pgroles already provides human-readable diffs and some summary output as part of its validate and diff CLI commands. These outputs are helpful for developers reviewing proposed changes before applying them. However, deeper GitOps integration would benefit from richer, more structured, and context-aware review summaries suitable for PR comments, Slack, or agent/bot consumption.

What pgroles already has

  • Human-readable SQL plan output (diff command)
  • CLI summary of diff operations (creates, drops, alters, etc.)
  • Console warnings for common dangerous changes (DROP ROLE, grants to PUBLIC, etc.)
  • Error diagnostics with source file/line for validation failures

What could be improved/explored

  • Markdown/structured summary rendering for GitHub/GitLab/Slack PR comments:
    • Table of risk levels, change types, affected roles/objects, and source attribution
    • Per-change descriptions with source (filename/fragment)
  • Risk classification surfaced with badges or priority
  • Digest or fingerprint display, so reviewers know exactly what context was reviewed

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions