dev-ugurkontel/docsmoke
Validate executable Markdown snippets in CI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Apr 22, 2026
- License
- Apache 2.0
Pinned Snippet
uses: dev-ugurkontel/docsmoke@c32642cff1012e985a640f499d861ed4abf7d5ed # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| paths | Space-separated Markdown files or directories to scan. | no | "" |
| python-version | Python version used to install and run docsmoke. | no | 3.12 |
| package-spec | Optional pip install spec, for example `docsmoke==<exact-version>`. When omitted, the action installs the checked-out action source so the action ref and tool version stay aligned. | no | "" |
| config | Optional path to docsmoke.toml or pyproject.toml. | no | "" |
| output | Optional output file path. When set, `format` is also used. | no | "" |
| format | Output format used with `output`. | no | markdown |
| all-supported | Execute all supported fenced blocks, even when not explicitly marked. | no | false |
| fail-fast | Stop after the first failing snippet. | no | false |
| extra-args | Optional additional CLI arguments, one argument per line. | no | "" |
Outputs
no outputs