Adding WebIDL validation to auto-publish workflow #2518
Conversation
|
You can use spec-prod to publish to GitHub pages too btw. You won't need to setup bikeshed, and other GitHub actions. |
|
Yes, that what I tried first a year ago. However, our spec has some "unfixable" Bikeshed issues, so we had to use our own build flow to avoid spec-prod. Now I remember why we took this approach. Thanks for your pointer! I'll leave this open so I don't forget why we're using a custom spec building action. |
| @@ -23,6 +23,8 @@ jobs: | |||
| - name: Building index.html from index.bs | |||
| run: bash ./compile.sh | |||
| shell: bash | |||
| - name: Running WebIDL validation | |||
| uses: w3c/spec-prod@v2 | |||
There was a problem hiding this comment.
If you just want to use spec-prod to validate the IDL, perhaps you could use the BUILD_FAIL_ON spec-prod action setting to have Bikeshed die on nothing?
That won't give you an occasion to validate that the list of errors returned by Bikeshed is the list you expect, as done in the compile script, so probably not a good idea for actual publication to GitHub Pages.
| uses: w3c/spec-prod@v2 | |
| uses: w3c/spec-prod@v2 | |
| with: | |
| BUILD_FAIL_ON: nothing |
There was a problem hiding this comment.
Thanks for the tip! That might be a way to resolve this. I'll try to incorporate this idea to our workflow.
Just to be clear, spec-prod@v2 already includes Bikeshed and we don't need a custom step to run Bikeshed (L23~L25). Right?
@padenot I believe we're doing the text comparison (actual vs error) for some historical reasons. Do you have context on why we can't fix those Bikeshed errors? Wanted to ask before I jump in and investigate.
There was a problem hiding this comment.
Just to be clear, spec-prod@v2 already includes Bikeshed and we don't need a custom step to run Bikeshed (L23~L25). Right?
Correct. If the Bikeshed errors are fixed or ignored (with BUILD_FAIL_ON), spec-prod can fully replace the current workflow. You'll only need checkout step and spec-prod step then (spec-prod handles Python and Bikeshed and all).
There was a problem hiding this comment.
@hoch, last I checked, with Raymond, some time ago, there were shortcomings/bugs in bikeshed, preventing us to fix those, but of course they might well be fixed now.
There was a problem hiding this comment.
Thank you both for clarification!
|
adding-idl-validation-action |
This PR adds a new step in the auto-publish workflow to use the WebIDL validation. It also updates some old version of GitHub actions to the latest ones.
Context: #2514 (comment)