w3c
Use GitHub Actions to build/validate/publish clreq?
https://github.com/w3c/spec-prod is a new, specialized tool that easily automates all steps of building, validating, and publishing specs. To set it up, we just need to add one GitHub Actions file. See webappsec-credential-management for an example.
After adding this file, we can autopublish clreq to https://www.w3.org/TR/ , and there's no need to:
- use our manifest tool to list items
- run the validators
- copy remote assets to local repo and update the URLs as part of the publication process for images in the gap analysis (when https://github.com/w3c/spec-prod/issues/32 is fixed)
- run curl
There is a downside: currently, only automatic publishing (on every git push) is supported, and manual publishing is not supported. This is tracked in https://github.com/w3c/spec-prod/issues/6
@r12a What do you think? Should we adopt this tool for clreq? What about other lreqs and string-meta / specdev / predefined-counter-styles etc.?
(As far as I know, the WebApps, WebRTC, Second Screen, Media, and WebAppSec Working Groups have adopted spec-prod.)
See also discussions in localizable-manifests: https://github.com/w3c/localizable-manifests/pull/10#discussion_r686414003
I think that the autopublish approach is of little use for the gap-analysis document, since the changes are not pushed to the repository.
Whether or not it's useful for the clreq requirements doc, is a question for the clreq group.
I'm hesitant to use it generally for WG Notes, for the reasons listed in the issue linked to just above, though i'm open to persuasion. Not sure whether it's useful during the WD phase of document devt.
I have been manually publishing clreq for the past few years. Before each publication, I would read the document thoroughly to make sure there were no major problems. I think we can keep it this way for now, unless someone objects to it.