just docs generates the images used in README.md using openscad. However these images are not perfectly reproducible, they can change depending on machine. Since the images need to be checked in in order to be displayed, this can lead to enormous diffs.
- Add a "canonicalization" step to the image generation step which transforms the images in such a way that a pixel-identical input will produce a binary-identical image output
- Create a workflow that verifies that the
just docs output does not change the committed images. People that make a PR that change the images will have to locally build and commit them, and the workflow ensures they have done this step.
just docsgenerates the images used inREADME.mdusingopenscad. However these images are not perfectly reproducible, they can change depending on machine. Since the images need to be checked in in order to be displayed, this can lead to enormous diffs.just docsoutput does not change the committed images. People that make a PR that change the images will have to locally build and commit them, and the workflow ensures they have done this step.