Skip to content

Added script to render index.html artifact to redirect to first changed symbol

Uli Köhler requested to merge ulikoehler/kicad-library-utils:html_diff_index_html into master

This MR adds a script to render index.html to provide either an overview, or directly redirect to the first HTML page. The resulting page with multiple changes looks like this:

image.png

Demo - multiple libs changed: ulikoehler/kicad-symbols!2

Demo - one lib changes: ulikoehler/kicad-symbols!1

This pull request uses a hack in visual_diff.sh so there is no need to change .gitlab-ci.yml. This is why index.html is placed at [artifacts]/diffs/index.html.diff/index.html.

We can't mkdir diffs in visual_diff.sh since that leads to .gitlab-ci.yml mkdir diffs failing -> pipeline fail.

We also can't execute any code after mkdir diffs , so the only way to make it work IMO is to make index.html look like diffs.

I changed it just for the demos so that it clones my utils repo instead of the official one.

Related Zulip discussion: https://kicad.zulipchat.com/#narrow/stream/260592-KLC/topic/index.2Ehtml.20feature.20for.20Visual.20Diff

The next step - not part of this merge request - would be to either create a GitHub bot to post updated links, or create a Tapermonkey script to inject a direct link it into the page (not sure if the latter one would work, but I could try)

As initially requested by @kliment1

Edited by Uli Köhler

Merge request reports