Skip to content

Latest commit

 

History

History
110 lines (63 loc) · 4.24 KB

options.md

File metadata and controls

110 lines (63 loc) · 4.24 KB
Raw

Options

Table of Contents

*W3C Publish: Using Echidna. Presently only supported with ReSpec.

TOOLCHAIN

Toolchain to use.

Possible values: respec, bikeshed.

Default: None. Inferred from SOURCE: respec if an index.html exists, or bikeshed if an index.bs exists.

SOURCE

Source file path.

Possible values: Any valid POSIX file path relative to repository root.

Default: None. Inferred from TOOLCHAIN: index.html/index.bs if exists.

VALIDATE_LINKS

Whether or not to check for broken hyperlinks.

Possible values: Boolean (see end of page)

Default: true

VALIDATE_MARKUP

Whether or not to validate markup using the Nu Html Checker.

Possible values: Boolean (see end of page)

Default: true

GH_PAGES_BRANCH

Whether or not to deploy to GitHub pages. Set to a Falsy value to not deploy, or provide a Git branch name to push to. You would need to enable GitHub pages publish source in repository settings manually.

Possible values:: Falsy (see end of page) or a git branch name.

Default: None

GH_PAGES_TOKEN

GitHub Personal access token. This field is required only if the default GitHub actions token doesn't have enough permissions, or you want to have more control. Make sure to pass it as a secret.

Possible values:: A valid personal GitHub token.

Default: GITHUB_TOKEN

W3C_ECHIDNA_TOKEN

The automated publication workflow requires a token associated with the specification you want to publish. 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".

Possible values: A valid Echidna token.

Default: None.

W3C_MANIFEST_URL

URL to Echidna manifest file. An Echidna manifest file needs live at the root of your repository. It must be accessible via GitHub pages.

An example of a minimal Echidna manifest file (say, <REPOSITORY_ROOT>/ECHIDNA):

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

Possible values: A publicly accessible URL to Echidna manifest.

Default: https://ORG.github.io/REPO/ECHIDNA

W3C_WG_DECISION_URL

A URL to the working group decision to use auto-publish, usually from a w3c mailing list.

Possible values: A non-exhaustive list of possible values:

Default: None.

W3C_NOTIFICATIONS_CC

Comma separated list of email addresses to CC. This field is optional.

Default: None.

Value Type Possible values
Truthy y, yes, true, 1, on
Falsy n, no, false, 0, off
Boolean Truthy or Falsy
None Indicates absence of a value.