Repository navigation
ci(ecad): ship interactive HTML viewer and visible before/after previews - #1296
Merged
Merged
Conversation
…ublic repo branch
…hing fork previews
jrsteensen
added a commit
that referenced
this pull request
Oct 23, 2026
jrsteensen
marked this pull request as ready for review
October 23, 2026 16:27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix ECAD review artifacts that have PNG/SVG output but no HTML viewer, and make visual changes visible without hunting through ZIP files.
sksat/kicadiff@v0.2.0for structural Markdown and raw renders, but disable its full-size image summary.index.htmlinside the same artifact directory asbefore/,after/,diff/and PCB layer/schematic-page assets.data:image URIs, so summaries now reference GitHub-renderable public HTTPS JPEG URLs.VIEW_ME_FIRST.txtinside each ZIP and a direct ZIP artifact download URL beside the summary images.workflow_runusing trustedmastercode andcontents: write, to a dedicatedecad-review-previewsbranch. On completion the original Actions summary's linked images become visible. The same mechanism covers forks without granting write to untrusted analysis. Viewer validation remains advisory.Validation
data:URI images. This PR now fixes those links and adds a post-run publisher.workflow_runexecutes only workflows onmaster, so the updated trusted publishing stage must first be merged before it can actually populate preview URLs. The PR remains draft until review; do not claim the images are fixed in a live summary just from CI success.Hosting
GitHub Actions artifacts are ZIP downloads, not hosted HTML. GitHub Pages is currently disabled on this repository. This PR makes the ZIP a complete portable interactive viewer and provides in-run previews; hosting
index.htmlat a direct website URL will need a separate Pages authorization/configuration decision.Advisory/nonblocking; independent of PDF Overlay Compare.
Preview hosting / security notes
runs/<run-id>/<project>/in theecad-review-previewsbranch. The sandboxed PR build stayscontents: read; only the separate trusted workflow obtains write privileges, validates the current PR/head SHA, and uploads whitelisted size-bounded JPEG bytes, not HTML/SVG/code.pull-requests: writeas well asissues: write. Whether that resolves the GitHub-side restriction needs live verification after merge.Current validation
The clean PR's CI run #39982208233 passed 11 unit tests, including HTTPS-only summary URLs, safe JPEG ZIP extraction, Git blob/tree publishing, stale PR handling, and simulated fork-comment behavior. The trusted
workflow_runimage publishing stage cannot run from a draft PR: actual hosted-image presentation must be verified after merging this workflow to the default branch.