workflow-image-readme-sync

Scan .github/workflows for Docker images built and pushed by this repository, then update the README.md image table with the discovered images, base images, build contexts, workflow paths, and concise agent-written descriptions based on each build context. Use this when asked to sync repository Docker image documentation from GitHub Actions workflows. Use when this capability is needed.

Jump to install

Repository: tomevault-io/skills-registry
Last source activity: May 23, 2026 at 22:30
Detected SKILL.md language: English
Stars: 0
Forks: 0

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/tomevault-io/skills-registry --skill workflow-image-readme-sync

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

2 files

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

Workflow Image README Sync

Use this skill when the user wants README.md updated from Docker image definitions in .github/workflows.

Workflow

Run python3 scripts/update_readme.py --print-discovery-json to discover images, base images, build contexts, and workflow paths.

Read each discovered build context, starting with its Dockerfile and only the nearby files needed to understand the image's purpose.

Write concise human descriptions in the style of product summaries, not low-level Dockerfile narration.

Save the descriptions in a JSON mapping from image name to description, then run python3 scripts/update_readme.py --description-file <file>.

Check the updated table in README.md and verify each row includes Image, Base Image, Context, a Workflow badge that links to the GitHub Actions workflow, and Description.

Notes

The updater rewrites only the content between the  and  markers in README.md.

The Python script is intentionally data-oriented. It discovers image metadata and renders the table, but the agent is responsible for the final description quality.

The repository-level scripts for this workflow live in ../../../scripts. Prefer ../../../scripts/update_readme.py and ../../../scripts/generate_readme_image_descriptions.py.

The Workflow column should render GitHub Actions badge images that link to each workflow page, rather than plain text workflow paths.

Prefer short summaries like Debian base image with custom ca certs or Vault running in agent mode with config templating.

If no images are found, the table is populated with a single None row so the README stays explicit.