Repository navigation
new runbooks prompt - #829
Conversation
dfaddcd to
55c49ab
Compare
WalkthroughAdds documentation under holmes/plugins/runbooks: updates README.md with a “Generating Runbooks” section and adds CLAUDE.md, a machine-readable runbook template plus catalog registration and file-naming guidance. No code, API, or exported/public-entity changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📥 CommitsReviewing files that changed from the base of the PR and between 9bd9ab37f882a6ab0796008e0eff865f7e6dd135 and 45185a1. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
holmes/plugins/runbooks/runbook-format.prompt.md (1)
1-37: Location and format violate prompt placement conventions. Move under prompts/ as a .jinja2 template.Org standard: “Prompts must be located at holmes/plugins/prompts/{name}.jinja2.” This file lives under runbooks/ and uses .prompt.md. If this is meant for programmatic use, relocate and convert to .jinja2. If it’s pure documentation, clarify that in README and consider keeping a canonical .jinja2 copy for tooling.
Proposed actions:
- Move to holmes/plugins/prompts/runbook-format.jinja2 and keep a documentation-friendly copy or a link from runbooks/.
- Update README references accordingly.
Would you like me to generate the .jinja2 version with placeholders and a minimal include-able schema?
🧹 Nitpick comments (4)
holmes/plugins/runbooks/runbook-format.prompt.md (1)
5-10: Add prerequisites/assumptions to the Goal section.Call out access requirements, environment preconditions, and safety boundaries upfront for safer runs.
Apply this diff:
## Goal - **Primary Objective:** Clearly define the specific category of issues this runbook addresses (e.g., "diagnose network connectivity problems", "troubleshoot pod startup failures", "investigate performance degradation"). - **Scope:** Specify the environment, technology stack, or system components covered by this runbook. - **Agent Mandate:** Explicitly state that the AI agent must follow the workflow steps sequentially and systematically without deviation to ensure consistent, thorough troubleshooting. - **Expected Outcome:** Define what successful completion of this runbook should achieve (root cause identification, issue resolution, or escalation criteria). +- **Prerequisites & Assumptions:** Enumerate access credentials, permissions, cluster contexts, and any non-destructive constraints.holmes/plugins/runbooks/README.md (3)
24-27: Align references with prompt placement convention.If you adopt the prompts/ .jinja2 standard, update this link to point to holmes/plugins/prompts/runbook-format.jinja2. If you keep this file as documentation, state that the canonical template for automation resides under prompts/.
Suggested edit after relocating:
-## Generating Runbooks +## Generating Runbooks @@ -To ensure all runbooks follow a consistent format and improve troubleshooting accuracy, contributors should use the standardized [runbook format prompt](runbook-format.prompt.md) when creating new runbooks. +To ensure all runbooks follow a consistent format and improve troubleshooting accuracy, contributors should use the standardized [runbook format prompt](../prompts/runbook-format.jinja2) when creating new runbooks. A documentation copy is available at [runbook-format.prompt.md](runbook-format.prompt.md).
30-31: Fix filename reference: use the actual template name.The file is named runbook-format.prompt.md (or runbook-format.jinja2 after relocation), not prompt.md.
Apply this diff:
-1. **Start with the Template**: Use `prompt.md` as your guide when creating new runbooks +1. **Start with the Template**: Use `runbook-format.prompt.md` (or `runbook-format.jinja2` if using the canonical template) as your guide when creating new runbooks
46-46: Clarify where generated runbooks should be stored and how to test them.Provide concrete next steps to integrate new runbooks into the project.
Apply this diff:
-When creating a runbook for a new issue category (e.g., storage problems, authentication failures), provide the issue description to an LLM along with the prompt template to generate a properly formatted runbook that follows the established patterns. +When creating a runbook for a new issue category (e.g., storage problems, authentication failures), provide the issue description to an LLM along with the prompt template to generate a properly formatted runbook that follows the established patterns. After generation: +1) Store structured runbooks under this directory following existing naming conventions, or add markdown runbooks to the catalog and update `catalog.json`. +2) Validate the YAML schema and step fields. +3) Test with `holmes investigate` to ensure the agent can execute the steps end-to-end.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
holmes/plugins/runbooks/README.md(1 hunks)holmes/plugins/runbooks/runbook-format.prompt.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-10T06:02:54.321Z
Learnt from: CR
PR: robusta-dev/holmesgpt#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-10T06:02:54.321Z
Learning: Applies to holmes/plugins/prompts/**/*.jinja2 : Prompts must be located at holmes/plugins/prompts/{name}.jinja2
Applied to files:
holmes/plugins/runbooks/runbook-format.prompt.md
🔇 Additional comments (1)
holmes/plugins/runbooks/README.md (1)
37-43: Benefits section looks good and aligns with goals.Clear articulation of consistency, agent compatibility, and maintainability benefits.
|
may add a reference to claude.md as well. |
Thanks. Since claude prompt is already used in holmegpt repo, so instead of a making a generic prompt markdown for different coding agent, I use claude.md instead. |
9bd9ab3 to
45185a1
Compare
|
@aantn @arikalon1 May I have your review please? |
58be330 to
45185a1
Compare
3 participants
This PR provides a prompt for the user the generate the runbook. The prompt defined the Goal, Workflow , Synthesize and Remediation of a runbook.
I did not automate the generating the runbook by extending the holmes CLI to have
holmes runbook gnerateconsidering runbook generation might requires multiple iterations and runbook source is dynamic.