Follow Bikeshed filename convention: Use index.bs #469
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change renames the spec source to
index.bs
(fromindex.src.html
), to conform it to the normal/expected Bikeshed filename convention.That makes the source immediately recognizable as a Bikeshed file (rather than, say, a Respec source file) to anyone looking at the repo, and to automated tooling such as https://github.com/w3c/spec-prod.
Otherwise, without renaming the source to
index.bs
, it’s necessary to feed additional non-default options to such tooling to tell it that we call our Bikeshed source “index.src.html”.Once this change is merged, we can do the following:
Switch our CI over to using https://github.com/w3c/spec-prod
https://github.com/w3c/spec-prod is a very new, specialized tool that easily automates all steps of building, validating, and publishing specs.
I’ve already set it up for the Credential Management spec. All that was needed was to add one GitHub Actions file:
https://github.com/w3c/webappsec-credential-management/blob/00cabe81f57ac8863afec40825f16e28fa144127/.github/workflows/build-validate-publish.yml#L1-L18
And when we move all the WebAppSec specs to also being autopublished to https://www.w3.org/TR/ spec, all that’ll be needed is to add one more variable to that config file.
But if we don’t rename the WebAppSec source files to follow the index.bs naming convention, then we’d need to add further options to the config files for every repo, to tell it we’re calling the source index.src.html. That’s not a big hardship, but it would be simpler to just follow the normal Bikeshed filename convention, and get the automatic benefits of that.
Drop Travis (.travis.yml)
For the CSP repo, we currently still have Travis set up to run Bikeshed on PR branches. Switching to https://github.com/w3c/spec-prod would let us drop Travis, because https://github.com/w3c/spec-prod provides the same capability, with HTML validation of the output thrown in for free.