Copyright © 2021 W3C ® (MIT, ERCIM, Keio, Beihang)
/TR should represent the web we want.
In order to keep it up-to-date, we need to reduce the gap with the editor's draft and faciliate the updates to /TR.
Echidna can process a document and publish to /TR if:
README.md
)
Examples: issue #199 and issue #261
To get started with Echidna, we recommend using the GitHub action spec-prod
written by Sid Vishnoi.
spec-prod
can:
The token provided by the team contact should be added to your repository as a repository secret.
# .github/workflows/pr-push.yml
name: CI
on:
pull_request: {}
push:
branches: [main]
jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: w3c/spec-prod@v2
with:
W3C_ECHIDNA_TOKEN: ${{ secrets.W3C_TR_TOKEN }}
W3C_WG_DECISION_URL: <DECISION>
By default, spec-prod
will look for source files index.html
(ReSpec) or index.bs
(Bikeshed).
spec-prod
offers a few options to customize the build, such as:
TOOLCHAIN
: to specify the processor ('respec' or 'bikeshed')
SOURCE
: to use a source document other than index.html/index.bs
VALIDATE_LINKS
: by default, spec-prod
checks for broken links. Set to false
if you want to skip that step
VALIDATE_MARKUP
: same as VALIDATE_LINKS
but for markup/CSS
W3C_BUILD_OVERRIDE
: options to override the bikeshed/respec configuration
W3C_NOTIFICATIONS_CC
: Comma separated list of email addresses to get the results of the request
# .github/workflows/echidna-publishing.yml
name: CI
on:
push:
branches: [main]
jobs:
main:
name: Build, Validate and Deploy
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: w3c/spec-prod@v2
with:
W3C_ECHIDNA_TOKEN: ${{ secrets.W3C_TR_TOKEN }}
TOOLCHAIN: bikeshed
SOURCE: foobar.bs
W3C_NOTIFICATIONS_CC: echidna@example.org
W3C_WG_DECISION_URL: https://lists.w3.org/Archives/Public/...
W3C_BUILD_OVERRIDE: |
shortname: spec-1
status: WD
More examples of configurations are listed in examples.md
The status of the workflow can be found in the 'Actions' tab, e.g. mediacapture-record:
spec-prod
will check the result of the request to Echidna a few times only. If the request is still pending when the workflow completes, the report will be sent to public-tr-notifications once it's over.
Although spec-prod
is the recommended way to publish /TR document with Echidna, there are other methods described in the wiki.