Switch build to GitHub action using spec-prod #262
Conversation
This creates a GitHub action that replaces the Travis CI worfklow for re-generating the specification and updating the `gh-pages` branch. The action uses w3c/spec-prod under the hoods: https://github.com/w3c/spec-prod/#spec-prod w3c/spec-prod takes care of everything and also validates the spec (markup and broken hyperlinks). Good thing about this approach is that no specific secret tokens are needed, since GitHub actions are allowed to push to the gh-pages branch. Also, no need to maintain a complex deploy script.
There was a typo in one of the links to the capabilities registry, which makes the validation fail. Also, GitHub does not serve Markdown files as HTML files on GitHub Pages by default. This update switches these links to `github.com` URLs.
|
So, build currently fails because HTML validation fails. Markup is invalid due to the CDDL messages appendix that has the structure |
See: https://tabatkins.github.io/bikeshed/#including-raw This avoids the HTML parsing that Bikeshed does and wrapping of paragraphs in `<p>` tags.
|
OK, I found the right include setting in Bikeshed to avoid the introduction of All things should work now and this PR should fix #259. |
index.bs
Outdated
| @@ -195,7 +195,8 @@ Non-Functional Requirements {#requirements-non-functional} | |||
| 1. It should be possible to implement an OSP agent using modest | |||
| hardware requirements, similar to what is found in a low end smartphone, | |||
| smart TV or streaming device. See the [Device | |||
| Specifications](device_specs.md) document for agent hardware specifications. | |||
| Specifications](https://github.com/w3c/openscreenprotocol/blob/master/device_specs.md) | |||
There was a problem hiding this comment.
Maybe these links should point to the gh-pages branch since we are serving the spec document from that branch?
I don't feel strongly since the two branches should always be kept in sync by the workflow.
There was a problem hiding this comment.
I would keep the gh-pages name as a "hidden" one: no need to expose the name of the branch that gets published as GitHub Pages, to avoid breaking links if we change the name. Actually, that applies to master as well, which we'll soon need to rename to main (we're progressively transitioning all W3C repositories to use main as the default branch instead of master).
I thought something had to be done for GitHub to publish Markdown files as HTML but I was wrong. It's all being done by default, you just have to replace the .md extension with .html. I pushed an update that targets the HTML pages under w3c.github.io (i.e. capabilities.html and device_specs.html). We can always choose a different theme and adjust the header and footer on these pages later on if we feel that's needed.
|
Looks good, and thanks again @tidoust. Feel free to merge this when you are ready. |
…his creates a GitHub action that replaces the Travis CI worfklow forre-generating the specification and updating the `gh-pages` branch.The action uses w3c/spec-prod under the hoods:https://github.com/w3c/spec-prod/#spec-prodw3c/spec-prod takes care of everything and also validates the spec (markup andbroken hyperlinks).Good thing about this approach is that no specific secret tokens are needed,since GitHub actions are allowed to push to the gh-pages branch. Also, no needto maintain a complex deploy script.This update also fixes broken links and markup validation issues. SHA: 684e1e5 Reason: push, by @tidoust Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This creates a GitHub action that replaces the Travis CI worfklow for re-generating the specification and updating the
gh-pagesbranch.The action uses w3c/spec-prod under the hoods:
https://github.com/w3c/spec-prod/#spec-prod
w3c/spec-prod takes care of everything and also validates the spec (markup and broken hyperlinks).
Good thing about this approach is that no specific secret tokens are needed, since GitHub actions are allowed to push to the gh-pages branch. Also, no need to maintain a complex deploy script.
Preview | Diff