Add workflow for automaticly rendering Images #5
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.
Workflow for rendering PCB images with github actions
The workflow is defined in
.github/workflows/images.yaml
and an example is provides in theREADME.md
of framework_input_controller (the images will show up after the first run of github actions is completed after the MR is merged).github/workflows/images.yaml
Contains an workflow with 2 jobs one for rendering the images using the ghcr.io/linalinn/kicad-render:nightly docker image and one for uploading the images to github pages.
The resulting images will be available under
crimier.github.io/MyKiCad/<path_in_repo_to_kicad_pcb>_top.png
or ascrimier.github.io/MyKiCad/<path_in_repo_to_kicad_pcb>_bottom.png
e.g. rendering
Laptop\ mods/framework_input_controller/framework_input_brkt.kicad_pcb
results inLaptop\ mods/framework_input_controller/framework_input_brkt_top.png
andLaptop\ mods/framework_input_controller/framework_input_brkt_bottom.png
currently 3D models form kicad-package3d are not rendered due to the official kicad image missing some configuration that happen when kicad is first started.
GitHub pages
Also it maybe need to configure github pages to use github actions for deployments see step 5