Automate running TD rendering script

[danielpeintner]

Changes to the TD document require to run

npm run render
or
./render.sh

locally to get the generated index.html.

I wonder whether it makes sense to automate this process based on each commit.
Do we want to investigate how to do that or are there any reasons why we did not do that in the first place?

[egekorkan]

Also as you mentioned, npm run render does not work for windows

[takuki]

I use cygwin to run npm run render on Windows, and it runs fine.

GitHub provides a function called "GitHub Actions" for CI/CD.

[takuki]

During March 6th TD telecon, @danielpeintner mentioned he can look into the feasibility.
However, the participants noted this is not a pressing issue. See minutes here.

[sebastiankb]

what is the status here?

[danielpeintner]

I can try to setup a GitHub action as mentioned here. Maybe we do that after FPWD.

I see 2 issue:

1. We need to test with the official repo and can not easily play around without (I will look into whether it can be tested with a fork too)
2. We need to add credentials since after successfully rendering we need to push the update to the repo (see here)

@ashimura I wonder whether there are other W3C repos doing something similar?

[egekorkan]

It would be good to know what kind of GitHub payment plan the W3C has since our builds will consume minutes that are shared by the entire W3C organization in GitHub. See https://github.com/pricing

[sebastiankb]

is this something what we can simple do as GitHub Actions?

[danielpeintner]

I think both can work, Travis and GitHub actions.

I noticed that the render script causes some noise after each run (e.g., always updating SVG images etc). Not sure what we could do about that. If I work on a PR without changing SVG details I simply don't commit those changes. A script can not do so but that might be a non-issue...

[danielpeintner]

@JKRhb I recall you mentioned that you want to work on automating the render process. Is this correct? I do not find any issue / mentioning anywhere. Thanks for any feedback!

[JKRhb]

@JKRhb I recall you mentioned that you want to work on automating the render process. Is this correct? I do not find any issue / mentioning anywhere. Thanks for any feedback!

I think we discussed this in the last TD call, but arrived at the conclusion that we wanted to use a pre-commit hook instead? I think @relu91 wanted to create a PR for that.

[danielpeintner]

#1549 adds husky pre-commit for rendering but does not fully solve this issue (rendering is done locally). Having said that, it will definitely help to reduce issues in may cases...

[sebastiankb]

I propose to close this issue since for TD2.0 we should re-design the spec generation

[sebastiankb]

from today's TD call, decided to close this issue