Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding WebIDL validation to auto-publish workflow #2518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding WebIDL validation to auto-publish workflow #2518

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/auto-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Checking out the main branch
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Setting up Python 3.7
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: '3.7'
- name: Installing and updating Bikeshed
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
uses: w3c/spec-prod@v2
uses: w3c/spec-prod@v2
with:
BUILD_FAIL_ON: nothing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you both for clarification!

- name: Deploying to gh-pages branch
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
Expand Down