/runme-action-examples

Runme action examples

Primary LanguageTypeScriptApache License 2.0Apache-2.0

runme
id version
01HJ6H1NC35W3Y48P7009E4EQ6
v2.0

Runme Action Examples

A curated collection of examples using the official Runme action

Why use Runme action

Instead of calling commands and scripts directly as part of your CI step, link existing code snippets from your project documentation into the CI execution to ensure that they stay up to date and valid. It binds documentation snippets with your CI/CD process and helps validate correctness of your project documentation.

The action is powered by Runme which is a tool that helps you supercharge your markdown files.

Examples

Name Runbook GitHub Workflow
Basic Node.js Http Api example README.md nodejs.yml