Skip to content

fix(readme): PNG hero + no SVG in the package README (unblocks the v7.8.106 release) - #13

Merged
thenabbu merged 1 commit into
bc/mainfrom
docs/readme-png-fix
Oct 30, 2026
Merged

thenabbu merged 1 commit into
bc/mainfrom
docs/readme-png-fix

Conversation

@thenabbu

Copy link
Copy Markdown
Owner

Why

The README redesign merged, but the auto-release for 7.8.106 failed — not on tests, on packaging:

##[error]SVGs are restricted in README.md; please use other file image formats, such as PNG:
https://raw.githubusercontent.com/.../docs/assets/hero.svg

vsce refuses to build a .vsix whose README contains an <img> pointing at an SVG. The package README is exactly the text the Marketplace listing renders, so the release could never ship with it as-is.

Fix

  • Render the hero to docs/assets/hero.png with headless Chromium at 2x (2560×680, 596 KB) and point the package README at the PNG. The design is identical — same source SVG, just rasterised.
  • The root README keeps the SVG: GitHub renders it and it stays crisp at any width. The restriction only applies to the packaged copy.
  • Drop the SVG badges from the package README (the Marketplace badge service is SVG-only, so they can't be packaged). Replaced with one plain text line carrying the same facts: MIT licensed · qwen-3.8-27b · deepseek-v4.1-flash · no telemetry.

Verification

Packaged locally with the real tool before pushing:

npx @vscode/vsce@4.0.0 package --no-dependencies
→ DONE  Packaged: bharatcode-vscode-7.8.106.vsix (5 files)

Previously this failed at the same step. Root README untouched by this commit.

vsce refuses to package a README containing an <img> pointing at an SVG:

  SVGs are restricted in README.md; please use other file image formats,
  such as PNG

That killed the release build for 7.8.106 (the package README is the text the
Marketplace listing renders). Two changes:

- Render the hero banner to docs/assets/hero.png via headless Chromium at 2x
  (2560x680) so the packaged copy keeps the same design, and point the package
  README at the PNG. The root README keeps the SVG - GitHub renders it and it
  scales losslessly there.
- Drop the SVG shields/vsmarketplace badges from the package README; the
  Marketplace badge service is SVG-only, so they cannot be packaged. Replaced
  with a plain text line carrying the same facts.

Verified with `vsce package` locally before pushing: packages clean.
@thenabbu
thenabbu merged commit c7393f2 into bc/main Oct 30, 2026
3 checks passed
@thenabbu
thenabbu deleted the docs/readme-png-fix branch October 30, 2026 01:42
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.

1 participant