Skip to content
This repository has been archived by the owner before Nov 9, 2022. It is now read-only.

w3c/respec-w3c-auto-publish

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Deprecated: Use spec-prod instead.


ReSpec W3C Auto-Publish (GitHub Action)

GitHub action to validate a ReSpec document and publish it as a TR using Echidna.

The document is published only when a PR is merged. Validation is done when a PR is created/updated and merged.

Inputs

Working Group Chairs and W3C Team members can request a token directly from the W3C. This can then be saved as ECHIDNA_TOKEN in your repository settings under "Secrets".

Please see action.yml

Example Usage

You need two things:

  1. an "ECHIDNA" manifest file
  2. an action.yml file

ECHIDNA manifest file

The ECHINA manifest file needs live at the root of your repository and make sure it's accessible via GitHub pages!

Just change your-spec-shortname to whatever your spec's short name is.

index.html?specStatus=WD&shortName=your-spec-shortname respec

action.yml

Place this file in ".github/workflows/action.yml" (or some other filename if you'd like) and change things as appropriate for your spec.

name: Node CI

on:
  push:
    branches:
      - gh-pages # change to your default branch
  pull_request: {}

jobs:
  validate-and-publish:
    name: Validate and Publish
    runs-on: ubuntu-latest # only linux supported at present
    steps:
      - uses: actions/checkout@v2
      - uses: w3c/respec-w3c-auto-publish@v1 # use the action
        with:
          ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
          ECHIDNA_MANIFEST_URL: "https://w3c.github.io/your_spec_repo/ECHIDNA"
          # Please use the URL that's appropriate for your working group!
          WG_DECISION_URL: "https://lists.w3.org/Archives/Public/public-webapps/2014JulSep/0627.html"
          CC: "foo@bar.com,bar@foo.com"
          CHECK_LINKS: true # Validate links and cross references; default: true
          VALIDATE_MARKUP: true # Validate HTML markup; default: true

WG_DECISION_URL

Here are some of the possible values of WG_DECISION_URL for various working groups:

WebApps WG
https://lists.w3.org/Archives/Public/public-webapps/2014JulSep/0627.html
Media Capture WG
https://lists.w3.org/Archives/Public/public-media-capture/2015Dec/0031.html
Second Screen WG
https://lists.w3.org/Archives/Public/public-secondscreen/2015Jun/0096.html
Web RTC
https://lists.w3.org/Archives/Public/public-webrtc/2016Mar/0031.html
Aria
https://lists.w3.org/Archives/Public/public-html-admin/2015May/0021.html
Device APIs
https://lists.w3.org/Archives/Public/public-device-apis/2015Oct/att-0037/minutes-2015-10-15.html#item05

About

[DEPRECATED] GitHub action to validate a ReSpec document and publish it using Echidna.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project