generate_runbook

To generate a deployment runbook, you provide your project name, version, and an optional template. The tool then outputs a Markdown file containing pre-deployment checks, deployment steps, verification procedures, and rollback plans.

A deployment runbook is a structured document outlining pre-deployment checks, deployment steps, verification, and rollback plans. You need one to reduce manual effort and human error during release workflows across projects.

You can customize a deployment checklist by providing a specific template in the JSON input along with your project and version. The runbook generation applies this template to tailor the documentation for that release.

No, you do not need to specify a template to generate a deployment runbook. Template input is optional, and if omitted, the generation process automatically uses a standard default template to create the document.

The generated deployment runbook file is saved as a Markdown document in the output directory. The filename follows the format output/runbook-<project>-<version>.md based on your provided inputs.

The required inputs to automate deployment documentation generation are the project name and version number. The template input is optional and defaults to standard if not provided during the runbook creation process.