Skip to content

Skip x.x.x and TBD placeholder tags in docker image validator#1191

Merged
dkijania merged 1 commit intomainfrom
dkijania/validate-docker-images-skip-placeholders
Apr 27, 2026
Merged

Skip x.x.x and TBD placeholder tags in docker image validator#1191
dkijania merged 1 commit intomainfrom
dkijania/validate-docker-images-skip-placeholders

Conversation

@dkijania
Copy link
Copy Markdown
Member

@dkijania dkijania commented Apr 26, 2026

Summary

  • The docker image validator (scripts/validate-docker-images.js) skips placeholders wrapped in {}, <>, $, or [], but the docs frequently use bare literals like 3.x.x or TBD to mark a version the reader must substitute.
  • Today those tags are sent to Docker Hub, return 404, and fail CI for any docs PR that uses the convention (e.g. PR added initial draft for upgrade to mesa #1133 / Mesa upgrade docs).
  • Add two tag-side patterns (case-insensitive) to hasTemplatePlaceholders: x.x[.x] / X.X[.X] and TBD. Concrete versions like 3.0.0 are still validated.

Test plan

  • Unit-checked the helper against the failing tags from PR added initial draft for upgrade to mesa #1133:
    • minaprotocol/mina-daemon-auto-hardfork:3.x.x-bullseye-mainnet → SKIP
    • minaprotocol/mina-daemon-auto-hardfork:3.x.x-noble-mainnet → SKIP
    • minaprotocol/mina-daemon:3.x.x-bullseye-mainnet → SKIP
    • minaprotocol/mina-daemon:TBD-bullseye-mainnet → SKIP
    • minaprotocol/mina-daemon:X.X-bullseye-mainnet → SKIP
    • minaprotocol/mina-daemon:3.0.0-bullseye-mainnet → CHECK (still validated)
  • Verify the validate-docker-images GitHub Actions check stays green on this PR.
  • Once merged, rebase PR added initial draft for upgrade to mesa #1133 and confirm the placeholder tags it uses (3.x.x-*) no longer fail validation. Concrete 4.0.0-*-mesa example tags in added initial draft for upgrade to mesa #1133 will still need to be moved to 4.x.x (separate change).

🤖 Generated with Claude Code

The validator already skips placeholders wrapped in {}, <>, $, or [],
but docs frequently use literal placeholders like "3.x.x" or "TBD" to
mark a version the reader must substitute (e.g. an unpublished release).
Treat those as placeholders too so the validator does not 404 on tags
that intentionally don't exist yet.

Recognised tag-side patterns (case-insensitive):
- x.x, x.x.x, X.X, X.X.X
- TBD

Concrete tags like 3.0.0 are still validated.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs2 Ready Ready Preview, Comment Apr 26, 2026 8:31pm

Request Review

@dkijania dkijania merged commit 850b096 into main Apr 27, 2026
3 checks passed
@dkijania dkijania deleted the dkijania/validate-docker-images-skip-placeholders branch April 27, 2026 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants