Skip to content

add support for AI agents#2166

Open
MichaelMraka wants to merge 1 commit into
RedHatInsights:masterfrom
MichaelMraka:pr2
Open

add support for AI agents#2166
MichaelMraka wants to merge 1 commit into
RedHatInsights:masterfrom
MichaelMraka:pr2

Conversation

@MichaelMraka
Copy link
Copy Markdown
Collaborator

@MichaelMraka MichaelMraka commented Apr 21, 2026

Secure Coding Practices Checklist GitHub Link

Secure Coding Checklist

  • Input Validation
  • Output Encoding
  • Authentication and Password Management
  • Session Management
  • Access Control
  • Cryptographic Practices
  • Error Handling and Logging
  • Data Protection
  • Communication Security
  • System Configuration
  • Database Security
  • File Management
  • Memory Management
  • General Coding Practices

Summary by Sourcery

Add internal documentation for using AI coding agents in this repository, describing system architecture, components, workflows, and development practices.

Documentation:

  • Introduce AGENTS.md as a comprehensive guide for AI coding agents interacting with the codebase.
  • Document the system architecture, core components, Kafka flows, deployment model, configuration, and development workflows for patchman-engine.

@MichaelMraka MichaelMraka requested a review from a team as a code owner April 21, 2026 12:15
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 21, 2026

Reviewer's Guide

Adds an AGENTS.md guide that documents patchman-engine’s architecture, components, workflows, and development practices specifically for AI coding agents, without changing application code or behavior.

File-Level Changes

Change Details Files
Introduce AGENTS.md as a comprehensive architecture and workflow guide tailored for AI coding agents working in this repository.
  • Create a new AGENTS.md file describing patchman-engine’s purpose and high-level system architecture.
  • Document responsibilities, configuration, dependencies, and Kafka topics for core services (manager, listener, evaluator variants).
  • Describe scheduled task components (VMaaS sync, system culling, cache refresh, cleaning, repack) and support components (database admin, turnpike admin API, platform mock).
  • Outline common development workflows, local dev/test commands, monitoring/observability endpoints, and configuration layout for components.
  • Provide communication flow diagrams and dependency diagrams to clarify how components interact via Kafka and PostgreSQL.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="AGENTS.md" line_range="475" />
<code_context>
+| `platform.content-sources.template` | Listener | Template assignments |
+| `patchman.evaluator.upload` | Evaluator-Upload | Newly uploaded systems |
+| `patchman.evaluator.recalc` | Evaluator-Recalc | Re-evaluation after sync |
+| `patchman.evaluator.user-evaluation` | Evaluator-User | User-initiated evaluations |
+
+### Produced Topics
</code_context>
<issue_to_address>
**issue (typo):** Align the consumer component name with the earlier "Evaluator-User-Evaluation" naming to avoid confusion.

This component is previously named "Evaluator-User-Evaluation"; here it’s "Evaluator-User". Please use a single, consistent name (e.g., "Evaluator-User-Evaluation") so it’s clear this is the same component.

```suggestion
| `patchman.evaluator.user-evaluation` | Evaluator-User-Evaluation | User-initiated evaluations |
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread AGENTS.md Outdated
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.18%. Comparing base (8b52cab) to head (63de47c).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2166      +/-   ##
==========================================
- Coverage   59.21%   59.18%   -0.04%     
==========================================
  Files         136      136              
  Lines        8781     8781              
==========================================
- Hits         5200     5197       -3     
- Misses       3035     3038       +3     
  Partials      546      546              
Flag Coverage Δ
unittests 59.18% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

TenSt
TenSt previously approved these changes Apr 21, 2026
Copy link
Copy Markdown
Collaborator

@TenSt TenSt left a comment

Choose a reason for hiding this comment

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

lgtm

swadeley
swadeley previously approved these changes Apr 22, 2026
Copy link
Copy Markdown
Contributor

@swadeley swadeley left a comment

Choose a reason for hiding this comment

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

ACK

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.

4 participants