search

w3c / picture-in-picture

Picture-in-Picture (PiP)
https://w3c.github.io/picture-in-picture
Other
311 stars 42 forks source link

Switch to spec-prod action and publish to /TR automatically #200

Closed tidoust closed 3 years ago

tidoust commented 3 years ago

Publication to gh-pages branch used Travis CI. The recommended way is now to use GitHub jobs with the spec-prod action: https://github.com/w3c/spec-prod

This action also takes care of keeping /TR in sync with the gh-pages branch, as resolved by the WG: https://github.com/w3c/media-wg/issues/27

Note publication requires a publication token, which I created and added as a secret in the repo settings, as needed: https://github.com/w3c/spec-prod/blob/main/docs/options.md#w3c_echidna_token

tidoust commented 3 years ago

Note spec-prod also validates the markup of the spec (and links in theory, but this has been temporarily disabled due to bugs).

beaufortfrancois commented 3 years ago

I'm not familiar enough with this to give you a proper review sadly. Do you know someone else?

tidoust commented 3 years ago

There aren't many things that can be done to validate this on top of giving it a try...

Various repos have the same deploy code, for instance:

I'm confident that the publication to gh-pages will work without problems, I recently enabled it with the same code for the Open Screen Protocol spec.

For the publication to /TR, the most likely outcome if something's wrong is that W3C's publication system will refuse to publish the update, in which case I would work with @deniak to understand what needs fixing.

deniak commented 3 years ago

LGTM as well!

tidoust commented 3 years ago

@beaufortfrancois I'll go ahead and merge. If something breaks, I'll look into it...

beaufortfrancois commented 3 years ago

No problem. Thanks!

deniak commented 3 years ago

The build is actually generating the snapshot for the ED. You can add the following config to generate the snapshot so it can be published to /TR.

W3C_BUILD_OVERRIDE: |
    shortname: picture-in-picture
    status: WD
tidoust commented 3 years ago

Ah, that makes sense. I'll add the override for status. In our case, shortname should not be needed because it already appears in the Bikeshed's metadata. I'll give it a try without.

tidoust commented 3 years ago

Automatic publication is now operational \o/

The version in /TR has been updated to match the current ED: https://www.w3.org/TR/2021/WD-picture-in-picture-20210315/

@beaufortfrancois, I had to commit a few additional changes to fix the automatic publication to:

beaufortfrancois commented 3 years ago

Thank you @tidoust! https://www.w3.org/TR/picture-in-picture/ works great!