Skip to content

Commit

Permalink
Enable auto-publication of the spec to /TR (#146)
Browse files Browse the repository at this point in the history
* Enable auto-publication of the spec to /TR

This update enables auto-publication of the spec as Candidate Recommendation
Draft to /TR, as agreed by the working group. It leverages the
[spec-prod action](https://github.com/w3c/spec-prod/) to do that.

This update also adjusts the workflow for the Editor's Draft itself. The source
spec is now to be found in the `main` branch, and instead of publishing the
source spec to GitHub Pages directly, the spec-prod action will rather deploy
the generated spec. Among other things, this makes it possible to integrate
the spec in Bikeshed's database for cross-referencing purpose (fixing #137).

The spec-prod action also takes care of running ReSpec on pull requests to
validate changes from an editorial perspective.

Note the `ECHIDNA_TOKEN` was added as secret to the repository.

* Add crEnd date to please ReSpec

ReSpec requires a `crEnd` date when the spec's status is CR or CRD. It makes
sense for CR (the date appears in the Status of this Document section). It does
not really make sense for CRD (the date does not appear anywhere). Anyway,
adding the parameter to please the ReSpec and make the auto-publication process
succeed.

* Fix HTML markup

A `<dl>` cannot be used without `<dt>`. Switching to `<ul>` instead to contain
the list of conditions.

Needed to enable auto-publication since the spec-prod action validates the HTML.
  • Loading branch information
tidoust authored Apr 22, 2022
1 parent 737f708 commit a2e218f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 41 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/auto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Build, Validate, Deploy and Publish
on:
pull_request: {}
push:
branches: [main]
jobs:
main:
name: Build and validate spec, then deploy and publish (only if push to main branch)
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: w3c/spec-prod@v2
with:
GH_PAGES_BRANCH: gh-pages
W3C_ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
W3C_WG_DECISION_URL: https://lists.w3.org/Archives/Public/public-secondscreen/2022Apr/0007.html
W3C_BUILD_OVERRIDE: |
specStatus: CRD
2 changes: 0 additions & 2 deletions ECHIDNA

This file was deleted.

50 changes: 11 additions & 39 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,6 @@
// previousMaturity: 'WD',
// previousPublishDate: '2015-11-02',
otherLinks: [
{
key: 'Version history',
data: [
{
value: 'GitHub w3c/remote-playback/commits',
href: 'https://github.com/w3c/remote-playback/commits/'
}
]
},
{
key: 'Test suite',
data: [
Expand All @@ -58,30 +49,11 @@
href: 'https://w3c-test.org/remote-playback/'
}
]
},
{
key: 'Participate',
data: [
{
value: 'GitHub w3c/remote-playback',
href: 'https://github.com/w3c/remote-playback/'
},
{
value: 'File an issue',
href: 'https://github.com/w3c/remote-playback/issues/new'
},
{
value: 'Open issues',
href: 'https://github.com/w3c/remote-playback/issues/'
},
{
value: 'Mailing-list (public-secondscreen@w3.org)',
href: 'https://lists.w3.org/Archives/Public/public-secondscreen/'
}
]
}
],
group: 'secondscreen',
github: 'https://github.com/w3c/remote-playback',
crEnd: '2017-11-30',
implementationReportURI: 'https://www.w3.org/wiki/Second_Screen/Implementation_Status#Remote_Playback_API'
};
</script>
Expand Down Expand Up @@ -1228,28 +1200,28 @@ <h4>
the <a>media element state</a>, and the <a>remote playback
state</a>:
</p>
<dl>
<dd>
<ul>
<li>
The <a>user agent</a> MUST send all media commands issued on the
associated {{HTMLMediaElement}} object to the <a>remote playback
device</a> in order to change its <a>remote playback state</a>;
</dd>
<dd>
</li>
<li>
The <a>remote playback device</a> SHOULD implement all media
commands sent by the <a>user agent</a>;
</dd>
<dd>
</li>
<li>
The <a>remote playback device</a> SHOULD send updates of
the <a>remote playback state</a> to the <a>user agent</a> that
affect any attribute exposed through the <a>media element
state</a>;
<dd>
<li>
The <a>user agent</a> MUST process all updates of the
<a>remote playback state</a> received from the <a>remote playback
device</a> and update the <a>local playback state</a> of the
media element accordingly.
</dd>
</dl>
</li>
</ul>
<p>
If sending any command fails, the <a>user agent</a> MAY
<a>disconnect from a remote playback device</a>.
Expand Down

0 comments on commit a2e218f

Please sign in to comment.