Skip to content

Commit

Permalink
Enable auto-publication
Browse files Browse the repository at this point in the history
This automates the publication of all 9 EME documents to the `gh-pages` branch
and to /TR, using the w3c/spec-prod action.

The `W3CTRMANIFEST` files are no longer needed as a result and nothing needs to
be Git-ignored anymore either.

Also note the change of shortname for Encrypted Media Extensions to
`encrypted-media-2`.
  • Loading branch information
tidoust committed Jul 22, 2024
1 parent 576c0e1 commit 256958e
Show file tree
Hide file tree
Showing 13 changed files with 92 additions and 74 deletions.
89 changes: 89 additions & 0 deletions .github/workflows/auto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Build, validate, deploy and publish

on:
# Worflow runs on pull requests where it makes sure that the spec can still be
# generated, that markup is valid and that there are no broken links, as
# well as on pushes to the default branch where it also deploys the generated
# spec to the gh-pages branch and publishes the result to /TR.
# The "workflow_dispatch" hook allows admins to also trigger the workflow
# manually from GitHub's UI.
pull_request: {}
push:
branches: [main]
workflow_dispatch:

jobs:
main:
runs-on: ubuntu-latest
strategy:
fail-fast: false
max-parallel: 1
matrix:
include:
- source: encrypted-media-respec.html
destination: index.html
echidna_token: ECHIDNA_TOKEN_ENCRYPTED_MEDIA
build_override: |
specStatus: WD
- source: hdcp-version-registry-respec.html
destination: hdcp-version-registry.html
echidna_token: ECHIDNA_TOKEN_EME_HDCP_VERSION_REGISTRY
build_override: |
specStatus: DRY
- source: format-registry/initdata/index-respec.html
destination: format-registry/initdata/index.html
echidna_token: ECHIDNA_TOKEN_EME_INITDATA_REGISTRY
build_override: |
specStatus: DRY
- source: format-registry/initdata/cenc-respec.html
destination: format-registry/initdata/cenc.html
echidna_token: ECHIDNA_TOKEN_EME_INITDATA_CENC
build_override: |
specStatus: NOTE
- source: format-registry/initdata/keyids-respec.html
destination: format-registry/initdata/keyids.html
echidna_token: ECHIDNA_TOKEN_EME_INITDATA_KEYIDS
build_override: |
specStatus: NOTE
- source: format-registry/initdata/webm-respec.html
destination: format-registry/initdata/webm.html
echidna_token: ECHIDNA_TOKEN_EME_INITDATA_WEBM
build_override: |
specStatus: NOTE
- source: format-registry/stream/index-respec.html
destination: format-registry/stream/index.html
echidna_token: ECHIDNA_TOKEN_EME_STREAM_REGISTRY
build_override: |
specStatus: DRY
- source: format-registry/stream/mp4-respec.html
destination: format-registry/stream/mp4.html
echidna_token: ECHIDNA_TOKEN_EME_STREAM_MP4
build_override: |
specStatus: NOTE
- source: format-registry/stream/webm-respec.html
destination: format-registry/stream/webm.html
echidna_token: ECHIDNA_TOKEN_EME_STREAM_WEBM
build_override: |
specStatus: NOTE
steps:
# See doc at https://github.com/actions/checkout#checkout-v2
- name: Checkout repository
uses: actions/checkout@v4

# See doc at https://github.com/w3c/spec-prod/#spec-prod
# The action only deploys the generated spec to the gh-pages branch when
# the workflow was triggered by a push to the default branch.
- name: Build and validate spec, push to gh-pages branch and deploy to /TR if needed
uses: w3c/spec-prod@v2
with:
TOOLCHAIN: respec
SOURCE: ${{ matrix.source }}
DESTINATION: ${{ matrix.destination }}
GH_PAGES_BRANCH: gh-pages
W3C_ECHIDNA_TOKEN: ${{ secrets[matrix.echidna_token] }}
W3C_WG_DECISION_URL: https://github.com/w3c/media-wg/issues/27
W3C_BUILD_OVERRIDE: ${{ matrix.build_override }}
48 changes: 0 additions & 48 deletions .github/workflows/generate-respec-html.yml

This file was deleted.

12 changes: 0 additions & 12 deletions .gitignore

This file was deleted.

3 changes: 1 addition & 2 deletions TEAM.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Updates to generated HTML are automated using GitHub Actions. On each push to
the `main` branch, the index and all registries will be regenerated and pushed
to the `gh-pages` branch.

See `generate-respec-html.py` and `.github/workflows/generate-respec-html.yml`
for details on how this is done.
See `.github/workflows/auto-publish.yml` for details on how this is done.
3 changes: 0 additions & 3 deletions W3CTRMANIFEST

This file was deleted.

4 changes: 2 additions & 2 deletions encrypted-media-respec.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
implementationReportURI: "https://w3c.github.io/test-results/encrypted-media/all.html",

// the specification's short name, as in https://www.w3.org/TR/short-name/
shortName: "encrypted-media",
shortName: "encrypted-media-2",

// if there a publicly available Editor's Draft, this is the link
edDraftURI: "https://w3c.github.io/encrypted-media/",
prevRecURI: "https://www.w3.org/TR/2017/REC-encrypted-media-20170918/",

// editors, add as many as you like
// only "name" is required
Expand Down
1 change: 0 additions & 1 deletion format-registry/initdata/cenc-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/initdata/keyids-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/initdata/registry-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/initdata/webm-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/stream/mp4-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/stream/registry-W3CTRMANIFEST

This file was deleted.

1 change: 0 additions & 1 deletion format-registry/stream/webm-W3CTRMANIFEST

This file was deleted.

0 comments on commit 256958e

Please sign in to comment.