respec-w3c-auto-publish's Introduction

⚠ 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:

an "ECHIDNA" manifest file
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: "[email protected],[email protected]"
          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

respec-w3c-auto-publish's People

Contributors

Stargazers

Watchers

respec-w3c-auto-publish's Issues

DECISION should be WG_DECISION_URL

The description should be "A link to the working group decision to use auto-publish".

CC takes a space separated list of emails

... so "[email protected],[email protected]"

Display echidna errors

As we already fetch the results like:

https://labs.w3.org/echidna/api/status?id=870bc1a8-ed54-4db6-a5a7-60f1c98d7a8c

It would be cool if pulled out the specberus failures and displayed them in a user-friendly manner.

PUBLISH probably shouldn't be an option

As the name implies "w3c-auto-publish", I don't think it should be an option. It should always publish (after validation succeeds).

Allow disabling some checks

Add inputs to disable certain checks in respec-validator

docs: add list of possible WG_DECISION_URL

From #11 (comment)

Move this repository to @W3C

@siusin We would like to transfer ownership of this repository to the W3C organization.
cc: @marcoscaceres

Archive this repo

Should this repo be archived and the Readme updated to point to w3c/spec-prod?

Publishing doesn't work

The request ended up with error:

{
  "status": "Form Content-Type not supported"
}

https://github.com/w3c/gamepad/runs/253545997#step:3:115

URL should be ECHIDNA_MANIFEST_URL

Dealing with post-CR documents

I assume this action will trigger an echidna publication even once a document has reached CR, which will then fail unless it is somehow marked as an editorial update.

It would ideal if the action could take this situation into account, e.g. by:

not auto-publishing once a doc has reached CR
accepting input one way or another to indicate that an editorial CR push is intended (although that might be too much of a footgun)

Recommend Projects

w3c / respec-w3c-auto-publish Goto Github PK