{"repo":"kjkuan/Runbook.md","free":true,"listed":false,"github":"https://github.com/kjkuan/Runbook.md","clone":"git clone https://github.com/kjkuan/Runbook.md.git","description":"Write Bash executable runbooks in Markdown.","language":"Shell","stars":31,"topics":["bash","runbook","markdown","task-runner","literate-programming","operations","ops","devops","devops-tools","sre"],"license":"BSD-2-Clause","category":"deployment-docker-iac","readme_excerpt":"[ /dev/null 2 &1; touch \"!---$$\"; : ]: # (Please keep this and the comment below) Runbook.md Runbook.md is a hack to create Bash executable [runbooks] in Markdown; it can also be used to write Bash [literate programs] or just executable Markdown documents in general. Runbook.md makes your actionable runbooks executable, literally. Markdown documents created with Runbook.md source its opinionated script (Runbook.sh), which provides error reporting, runbook logging, selective task execution, ... etc. [runbooks]: https://wa.aws.amazon.com/wellarchitected/2020-07-02T19-33-23/wat.concept.runbook.en.html [literate programs]: https://en.wikipedia.org/wiki/Literate programming Features - Error reporting includes stack traces back to the correct lines in the Markdown document. - Runbook logging includes both normal output logs, as well as, detailed trace logs with all command expansions for ease of debugging and auditing. - Organize your runbook with task functions, which are either discrete steps that can be executed sequentially and selectively, or are tasks that can be invoked individually in a specific order. Installation and Usage 1. Fork this repo. 2. Start writing your runbook in Markdown! You can put it in the runbooks/ folder, in which there's an example runbook to get you started. You can also create a new, or decorate an existing, Markdown file to be executable by Runbook.md by running this command: $ ./Runbook.sh -x myrunbook.md which will add the HTML header and footer co","default_branch":null,"files":null,"tree":[],"storefront":"/r/kjkuan","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/kjkuan/Runbook.md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}