Skip to content

docs(pr-poller): add activation guide for GitHub PR poller effect node [OMN-4972] - #822

Merged
jonahgabriel merged 1 commit into
mainfrom
jonah/omn-4972-github-pr-poller-effect
Mar 13, 2026
Merged

jonahgabriel merged 1 commit into
mainfrom
jonah/omn-4972-github-pr-poller-effect

Conversation

@jonahgabriel

@jonahgabriel jonahgabriel commented Mar 13, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add ACTIVATION.md to the node_github_pr_poller_effect node documenting the complete event flow from runtime tick through GitHub API polling to the omnidash Status page
  • Covers prerequisites (GITHUB_TOKEN), configuration, 8 triage states, and verification steps

Test plan

  • Pre-commit hooks pass
  • Documentation accurately reflects contract.yaml and omnidash StatusProjection
  • CI passes

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive activation guide for the GitHub PR Poller Effect, including setup prerequisites, configuration options, event flow explanation, and post-startup verification checklist.

…e [OMN-4972]

Document the event flow from runtime tick through GitHub API polling to
omnidash StatusProjection, including prerequisites, configuration, and
verification steps for the Status page.
@jonahgabriel
jonahgabriel enabled auto-merge March 13, 2026 21:41
@coderabbitai

coderabbitai Bot commented Mar 13, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

A new activation guide document is added for the GitHub PR Poller Effect node, providing setup instructions, configuration details, event flow descriptions, omnidash consumer information, PR triage state definitions, and post-startup verification procedures.

Changes

Cohort / File(s) Summary
GitHub PR Poller Effect Documentation
src/omnibase_infra/nodes/node_github_pr_poller_effect/ACTIVATION.md
New activation guide documenting prerequisites (GITHUB_TOKEN, services, Kafka), configuration options (poll_interval_seconds, repos, stale_threshold_hours), end-to-end event flow, omnidash consumer details, eight PR triage states, and verification checklist.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for the poller so keen,
Documents dreams, workflows pristine,
GitHub PRs dance in the flow,
With states and configs all aglow,
Through Kafka hops, omnidash does glow! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding an activation guide documentation for the GitHub PR poller effect node, with a relevant issue reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jonah/omn-4972-github-pr-poller-effect
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/omnibase_infra/nodes/node_github_pr_poller_effect/ACTIVATION.md`:
- Around line 26-33: The fenced flow block in ACTIVATION.md lacks a language tag
(causing markdownlint MD040); update the triple-backtick opening to include a
language such as text (e.g., ```text) for the block that documents the Runtime
tick -> NodeGitHubPRPollerEffect -> HandlerGitHubApiPoll ->
onex.evt.github.pr-status.v1 -> StatusProjection.upsertPR flow so the diagram is
treated as plain text (or use mermaid if you want diagram rendering).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 79202b8f-30fd-40ca-a9b5-324ee9d7ecd3

📥 Commits

Reviewing files that changed from the base of the PR and between 2622f27 and 4ff767a.

📒 Files selected for processing (1)
  • src/omnibase_infra/nodes/node_github_pr_poller_effect/ACTIVATION.md

Comment thread src/omnibase_infra/nodes/node_github_pr_poller_effect/ACTIVATION.md
@jonahgabriel
jonahgabriel added this pull request to the merge queue Mar 13, 2026
Merged via the queue into main with commit f6f5ebc Mar 13, 2026
30 checks passed
@jonahgabriel
jonahgabriel deleted the jonah/omn-4972-github-pr-poller-effect branch March 13, 2026 22:49
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.

1 participant