actions-marketplace-validations/rich-codex
Create rich code images for your docs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Apr 22, 2025
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/ewels_rich-codex@80de9de011c994f32274bb4cffee140567621d8e # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| search_include | Glob patterns to files in which to search for rich-codex comments | no | — |
| search_exclude | Glob patterns to exclude from search for rich-codex comments | no | — |
| no_search | Set to 'true' to disable searching for rich-codex comments | no | — |
| command | Specify a command to run to capture output | no | — |
| timeout | Maximum run time for command (seconds) | no | — |
| working_dir | Working directory to run command in (relative to root of project) | no | — |
| before_command | Setup commands to run before running main output command | no | — |
| after_command | Setup commands to run after running main output command | no | — |
| snippet | Literal code snippet to render | no | — |
| snippet_syntax | Language to use for snippet sytax highlighting | no | — |
| img_paths | Path to image filenames if using 'command' or 'snippet' | no | — |
| clean_img_paths | Remove any matching files that are not generated | no | — |
| rc_configs | Paths to YAML config files | no | — |
| fake_command | Pretend command to show in the screenshot prompt | no | — |
| hide_command | Hide the terminal prompt with the command at the top of the output | no | — |
| title_command | Use the command as the terminal title if not set explicitly | no | — |
| head | Show only the first N lines of output | no | — |
| tail | Show only the last N lines of output | no | — |
| trim_after | Don't print any more lines after this string is found | no | — |
| truncated_text | Text to show when '--head' or '--tail' truncate content | no | — |
| skip_git_checks | Skip safety checks for git repos | no | — |
| min_pct_diff | Minimum file percentage change required to update image | no | — |
| skip_change_regex | Skip image update if file changes match regex | no | — |
| terminal_width | Width of the terminal | no | — |
| terminal_min_width | Minimum width of the terminal (use trimming) | no | — |
| notrim | Disable automatic trimming of terminal width | no | — |
| terminal_theme | Colour theme | no | — |
| snippet_theme | Snippet Pygments theme | no | — |
| use_pty | Use a pseudo-terminal for commands (may capture coloured output) | no | — |
| log_verbose | Print verbose output to the console. | no | — |
| commit_changes | Automatically commit changes to the repository | no | — |
| error_changes | Exit with an error if changes are found (Ignored if 'commit_changes' is true) | no | true |
| use_uv | If true, use uv to manage python and install dependencies. | no | false |
| skip_python_setup | If true, skip Python setup (or skip uv setup if `use_uv` is true). Only use this if you already set up Python in a previous step, e.g. to install additional dependencies. When combined with `use_uv`, this assumes you already ran the `astral-sh/setup-uv` action. | no | false |
| python_verison | Which version of Python to use when setting up Python or uv. | no | 3 |
Outputs
no outputs