OpenAutomationProject / knx-uf-iconset

knx-user-forum.de icon set
Other
129 stars 49 forks source link

Automation to generate an overview Page with all Icons #5

Open Torsten- opened 2 years ago

Torsten- commented 2 years ago

For me the easiest way to find Icons is to use an html-page in my webbrowser with all icons on it. I can just scroll over them or use the search function of the browser. With a black background there is also no problem to see the white icons. In my explorer I can't get a good overview (white on white).

To get this html-page I built a short bash-Script (build_overview.sh). This script simply generates an html-page with all files found in raw_svg.

To automate this I scripted a GitHub Action (.github/workflow/main.yml). This Action runs automatically on every push to the repository and calls the build_overview.sh script. After the script-run, the Action pushes the built html-page to the GitHub repository. So you do not need to run the script manually.

In short: Just hit the "merge pull request" button and you will have an all-time up-to-date overview.html with all icons. And you don't have to do anything for it, Github does it for you ;-) On every new icon you push, the page will get updated magically ;-)

If you merge this request a next cool step would be to enable GitHub Pages. Then GitHub will host the html-page for you, and everyone can access it online. This is a setting in the repository you have to do manually:

Result: You get an URL and Page like this: https://torsten-.github.io/knx-uf-iconset/overview.html