search

w3c / spec-prod

GitHub Action to build ReSpec/Bikeshed specs, validate output and publish to GitHub pages or W3C
https://w3c.github.io/spec-prod/
MIT License
34 stars 21 forks source link

Force "prepare for TR" metadata setting for Bikeshed specs #128

Closed tidoust closed 2 years ago

tidoust commented 2 years ago

Initially raised against Bikeshed in https://github.com/tabatkins/bikeshed/issues/2242.

Bikeshed does not run a series of "fixups" to comply with PubRules by default. These need to be enabled through the Prepare for TR metadata setting. The action should take care of that automatically.

This has not been caught before because the PubRules checker remained somewhat lax on some of the rules. It now (starting March 3rd) enforces the order of stylesheets in particular, and automated publications of Bikeshed specs to TR no longer work as a result.

Although that setting is only needed to publish specs to TR, I would argue that the setting should be set for the generation of the Editor's Draft as well, so that the Editor's Draft and the TR version remain as close as possible.

sidvishnoi commented 2 years ago

For now, I think we should enable it for TR only to avoid breaking ED/gh-pages spec workflows.

tidoust commented 2 years ago

For now, I think we should enable it for TR only to avoid breaking ED/gh-pages spec workflows.

That's good for now. What I'm worried about is that editors and group participants probably look at the Editor's Draft most of the times, meaning that there will be fewer eyes on the TR version, and so fewer eyes to spot styling issues that could potentially arise when the order of stylesheets gets changed. I wouldn't expect that to be a common problem though.