mirror of
https://github.com/alirezarezvani/claude-skills.git
synced 2026-10-11 03:37:58 +00:00
9975cc9f9b
Ran the /update-docs pipeline post-v2.6.1 release. Most of the work was verification (docs already in sync from prior PRs #644, #649). Two real issues surfaced and fixed: 1. Codex sync bug (the headline fix) - scripts/sync-codex-skills.py used iterdir() which is single-level only - Missed the engineering/<plugin>/skills/<name>/SKILL.md pattern used by 4 Pocock plugins + many other standalone plugins restructured since PR #593 - Added Pattern 3 discovery: when <domain>/<plugin>/ contains a skills/ subdir with <name>/SKILL.md, recurse one level - Impact: Codex index 195 → 289 skills (+94 previously-hidden skills) - Gemini sync was already correct (uses recursive rglob) - OpenClaw was already correct (uses recursive find) 2. Stale skill counts in 2 user-facing docs - README.md: 268 → 272 (3 occurrences: tagline + badge + skills overview) - docs/getting-started.md: 246 → 272 (2 occurrences: meta description + FAQ) - All other files (CLAUDE.md, docs/index.md, mkdocs.yml site_description, marketplace.json) were already at 272 (refreshed in PRs #644 + #649) Other regenerations (no source changes — auto-updated from latest content): - docs/skills/engineering/*.md regenerated (picks up v2.6.1 description fixes) - docs/agents/*.md regenerated (no agent changes) - docs/commands/*.md regenerated (no command changes) - .codex/skills-index.json + 94 new symlinks (mostly Pocock + plugin-pattern skills that should have been there since PR #593) Verification: - All 5 user-facing docs (CLAUDE.md, README.md, docs/index.md, docs/getting-started.md, mkdocs.yml) show "272 skills" consistently - marketplace.json: v2.6.1, 43 plugins, 0 broken source paths - mkdocs build: 371 pages (280 skills + 58 agents + 33 commands), clean in 17.31s, no errors or new warnings - audit_skills.py: runs cleanly against 298 real skills No production code changes outside the Codex sync fix. This is a docs + tooling sweep, not a feature release. https://claude.ai/code/session_01VFreMf7XLBqMgjsrG4wSYe
87 lines
2.5 KiB
Markdown
87 lines
2.5 KiB
Markdown
---
|
|
title: "Runbook Generator — Agent Skill for Codex & OpenClaw"
|
|
description: "Generate operational runbooks from a service name — deployment, incident response, maintenance, and rollback workflows. Templated structure. Agent skill for Claude Code, Codex CLI, Gemini CLI, OpenClaw."
|
|
---
|
|
|
|
# Runbook Generator
|
|
|
|
<div class="page-meta" markdown>
|
|
<span class="meta-badge">:material-rocket-launch: Engineering - POWERFUL</span>
|
|
<span class="meta-badge">:material-identifier: `runbook-generator`</span>
|
|
<span class="meta-badge">:material-github: <a href="https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/runbook-generator/SKILL.md">Source</a></span>
|
|
</div>
|
|
|
|
<div class="install-banner" markdown>
|
|
<span class="install-label">Install:</span> <code>claude /plugin install engineering-advanced-skills</code>
|
|
</div>
|
|
|
|
|
|
**Tier:** POWERFUL
|
|
**Category:** Engineering
|
|
**Domain:** DevOps / Site Reliability Engineering
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows.
|
|
|
|
## Core Capabilities
|
|
|
|
- Runbook skeleton generation from a CLI
|
|
- Standard sections for start/stop/health/rollback
|
|
- Structured escalation and incident handling placeholders
|
|
- Reference templates for deployment and incident playbooks
|
|
|
|
---
|
|
|
|
## When to Use
|
|
|
|
- A service has no runbook and needs a baseline immediately
|
|
- Existing runbooks are inconsistent across teams
|
|
- On-call onboarding requires standardized operations docs
|
|
- You need repeatable runbook scaffolding for new services
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Print runbook to stdout
|
|
python3 scripts/runbook_generator.py payments-api
|
|
|
|
# Write runbook file
|
|
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md
|
|
```
|
|
|
|
---
|
|
|
|
## Recommended Workflow
|
|
|
|
1. Generate the initial skeleton with `scripts/runbook_generator.py`.
|
|
2. Fill in service-specific commands and URLs.
|
|
3. Add verification checks and rollback triggers.
|
|
4. Dry-run in staging.
|
|
5. Store runbook in version control near service code.
|
|
|
|
---
|
|
|
|
## Reference Docs
|
|
|
|
- `references/runbook-templates.md`
|
|
|
|
---
|
|
|
|
## Common Pitfalls
|
|
|
|
- Missing rollback triggers or rollback commands
|
|
- Steps without expected output checks
|
|
- Stale ownership/escalation contacts
|
|
- Runbooks never tested outside of incidents
|
|
|
|
## Best Practices
|
|
|
|
1. Keep every command copy-pasteable.
|
|
2. Include health checks after every critical step.
|
|
3. Validate runbooks on a fixed review cadence.
|
|
4. Update runbook content after incidents and postmortems.
|