BREAKING CHANGE: rename TYPE to TOOLCHAIN

Author: sidvishnoi

action.yml

@@ -7,7 +7,7 @@ branding:
   color: blue
 
 inputs:
-  TYPE:
+  TOOLCHAIN:
     description: Possible values - 'respec', 'bikeshed'
   SOURCE:
     description: Source file path.
@@ -51,7 +51,7 @@ runs:
         echo "::endgroup::"
       shell: bash
       env:
-        INPUTS_TYPE: ${{ fromJson(steps.prepare.outputs.all).type }}
+        INPUTS_TOOLCHAIN: ${{ fromJson(steps.prepare.outputs.all).toolchain }}
         HOME: /home/runner
 
     - name: Generate Static HTML
@@ -62,7 +62,7 @@ runs:
         echo "::endgroup::"
       shell: bash
       env:
-        INPUTS_TYPE: ${{ fromJson(steps.prepare.outputs.all).type }}
+        INPUTS_TOOLCHAIN: ${{ fromJson(steps.prepare.outputs.all).toolchain }}
         INPUTS_SOURCE: ${{ fromJson(steps.prepare.outputs.all).source }}
 
     - name: Validate hyperlinks

build.js

@@ -1,23 +1,23 @@
 // @ts-check
 const { env, exit, setOutput, sh } = require("./utils.js");
 
-const type = env("INPUTS_TYPE");
+const toolchain = env("INPUTS_TOOLCHAIN");
 const source = env("INPUTS_SOURCE");
 
 // Please do not rely on this value. If you would like this to be available as
 // an action output, file an issue.
 const outputFile = source + ".built.html";
 
 (async () => {
-	switch (type) {
+	switch (toolchain) {
 		case "respec":
 			console.log(`Converting ReSpec document '${source}' to HTML...`);
 			return await sh(`respec -s "${source}" -o "${outputFile}"`, "stream");
 		case "bikeshed":
 			console.log(`Converting Bikeshed document '${source}' to HTML...`);
 			return await sh(`bikeshed spec "${source}" "${outputFile}"`, "stream");
 		default:
-			throw new Error(`Unknown "type": "${type}"`);
+			throw new Error(`Unknown "TOOLCHAIN": "${toolchain}"`);
 	}
 })()
 	.then(() => setOutput("output", outputFile))

docs/examples.md

@@ -41,7 +41,7 @@ jobs:
 
 ## Specify toolchain: Bikeshed or ReSpec
 
-Provide `TYPE` if the action cannot figure out the toolchain itself, or if you like to be explicit.
+Specify `TOOLCHAIN` if the action cannot figure out the toolchain itself, or if you like to be explicit.
 
 ```yaml
 # .github/workflows/pr.yml
@@ -56,7 +56,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: sidvishnoi/w3c-deploy@v1
         with:
-          TYPE: respec # or bikeshed
+          TOOLCHAIN: respec # or bikeshed
 ```
 
 ## Deploy to GitHub pages

docs/options.md

@@ -2,16 +2,16 @@
 
 ## Table of Contents
 
-- General: [`TYPE`](#type), [`SOURCE`](#source)
+- General: [`TOOLCHAIN`](#toolchain), [`SOURCE`](#source)
 - Validation: [`VALIDATE_LINKS`](#validate_links), [`VALIDATE_MARKUP`](#validate_markup)
 - GitHub Pages: [`GH_PAGES_BRANCH`](#gh_pages_branch), [`GH_PAGES_TOKEN`](#gh_pages_token)
 - W3C Publish\*: [`W3C_ECHIDNA_TOKEN`](#w3c_echidna_token), [`W3C_MANIFEST_URL`](#w3c_manifest_url), [`W3C_WG_DECISION_URL`](#w3c_wg_decision_url), [`W3C_NOTIFICATIONS_CC`](#w3c_notifications_cc)
 
 \*W3C Publish: Using Echidna. Presently only supported with ReSpec.
 
-## `TYPE`
+## `TOOLCHAIN`
 
-Toolchain type.
+Toolchain to use.
 
 **Possible values:** `respec`, `bikeshed`.
 
@@ -23,7 +23,7 @@ Source file path.
 
 **Possible values:** Any valid POSIX file path relative to repository root.
 
-**Default:** None. Inferred from `TYPE`: `index.html`/`index.bs` if exists.
+**Default:** None. Inferred from `TOOLCHAIN`: `index.html`/`index.bs` if exists.
 
 ## `VALIDATE_LINKS`
 

prepare.js

@@ -32,7 +32,7 @@ async function main() {
 
 /**
  * @typedef {object} Inputs
- * @property {"respec" | "bikeshed"} [inputs.TYPE]
+ * @property {"respec" | "bikeshed"} [inputs.TOOLCHAIN]
  * @property {string} [inputs.SOURCE]
  * @property {string} [inputs.VALIDATE_LINKS]
  * @property {string} [inputs.VALIDATE_MARKUP]
@@ -58,7 +58,7 @@ async function main() {
  */
 async function processInputs(inputs, githubContext) {
 	return {
-		...typeAndInput(inputs),
+		...toolchainAndSource(inputs),
 		validate: validation(inputs),
 		deploy: {
 			ghPages: githubPagesDeployment(inputs, githubContext),
@@ -68,48 +68,48 @@ async function processInputs(inputs, githubContext) {
 }
 
 /**
- * Figure out "type" and "source".
+ * Figure out "toolchain" and input "source".
  * @param {Inputs} inputs
  */
-function typeAndInput(inputs) {
-	let type = inputs.TYPE;
+function toolchainAndSource(inputs) {
+	let toolchain = inputs.TOOLCHAIN;
 	let source = inputs.SOURCE;
 
-	if (type) {
-		switch (type) {
+	if (toolchain) {
+		switch (toolchain) {
 			case "respec":
 				source = source || "index.html";
 				break;
 			case "bikeshed":
 				source = source || "index.bs";
 				break;
 			default:
-				exit(`Invalid input "type": ${type}`);
+				exit(`Invalid input "TOOLCHAIN": ${toolchain}`);
 		}
 	} else if (!source) {
-		exit(`Either of "type" or "source" must be provided.`);
+		exit(`Either of "TOOLCHAIN" or "SOURCE" must be provided.`);
 	}
 
 	if (!existsSync(source)) {
 		exit(`"source" file "${source}" not found.`);
 	}
 
-	if (!type) {
+	if (!toolchain) {
 		switch (source) {
 			case "index.html":
-				type = "respec";
+				toolchain = "respec";
 				break;
 			case "index.bs":
-				type = "bikeshed";
+				toolchain = "bikeshed";
 				break;
 			default:
 				exit(
-					`Failed to figure out "type" from "source". Please specify the "type".`,
+					`Failed to figure out "TOOLCHAIN" from "SOURCE". Please specify the "TOOLCHAIN".`,
 				);
 		}
 	}
 
-	return { type, source };
+	return { toolchain, source };
 }
 
 /**

setup.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 set -e
-if [ -z "$INPUTS_TYPE" ]; then
-    echo "Envirnoment variable \"INPUTS_TYPE\" must be set."
+if [ -z "$INPUTS_TOOLCHAIN" ]; then
+    echo "Envirnoment variable \"INPUTS_TOOLCHAIN\" must be set."
     exit 1
 fi
 
@@ -12,7 +12,7 @@ echo "::set-env name=PUPPETEER_EXECUTABLE_PATH::/usr/bin/google-chrome"
 export PATH=$HOME/.local/bin:$PATH
 echo "::add-path::$HOME/.local/bin"
 
-case $INPUTS_TYPE in
+case $INPUTS_TOOLCHAIN in
 respec)
     echo "Installing ReSpec..."
     export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1