Initial commit

Author: sidvishnoi

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+open_collective: sidvishnoi
+custom:
+  - https://opencollective.com/respec

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sid Vishnoi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# ReSpec W3C Auto-Publish (GitHub Action)
+
+This action lets you validate a ReSpec based spec and publish them to /TR/
+
+## Inputs
+
+Please see [action.yml](action.yml)
+
+## Example Usage
+
+``` yaml
+name: Node CI
+
+on:
+  push:
+    branches:
+      - gh-pages
+  pull_request: {}
+
+jobs:
+  validate-and-publish:
+    name: Validate and Publish
+    runs-on: ubuntu-latest # only linux supported at present
+    steps:
+      - uses: actions/checkout@v1
+      - uses: sidvishnoi/respec-w3c-auto-publish # use the action
+        with:
+          ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
+          GH_USER: ${{ secrets.GH_USER }}     # optional
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}   # optional
+          URL: "https://w3c.github.io/gamepad/W3CTRMANIFEST"
+          DECISION: "https://lists.w3.org/Archives/Public/public-webapps/2014JulSep/0627.html"
+          CC: "[email protected]"
+          PUBLISH: ${{ github.event_name != 'pull_request' }} # publish only on merge (default: false)
+```

action.yml

@@ -0,0 +1,29 @@
+name: 'ReSpec W3C Auto-Publish'
+author: 'Sid Vishnoi'
+description: 'Validate ReSpec based specs and publish to /TR/'
+inputs:
+  ECHIDNA_TOKEN:
+    description: 'Echidna token'
+    required: true
+  GH_USER:
+    description: 'GitHub user login. Used with respec-validator for API request quota limits.'
+    required: false
+  GH_TOKEN:
+    description: 'GitHub user personal token. Used with respec-validator for API request quota limits.'
+    required: false
+  URL:
+    description: 'TR Manfiest URL. Example: https://w3c.github.io/gamepad/W3CTRMANIFEST'
+    required: true
+  DECISION:
+    description: 'Decision'
+    required: true
+  CC:
+    description: "CC to email address"
+    required: true
+  PUBLISH:
+    description: 'Whether to publish to /TR/ or not'
+    required: false
+    default: false
+runs:
+  using: 'node12'
+  main: 'index.js'

index.js

@@ -0,0 +1,114 @@
+const https = require('https');
+const { existsSync } = require('fs');
+const { spawn } = require('child_process');
+
+// GitHub JavaScript Actions require we "must include any package dependencies
+// required to run the JavaScript code" - import node_modules in version control
+// or other weird things.
+// (https://help.github.com/en/articles/creating-a-javascript-action#commit-and-push-your-action-to-github).
+// To overcome that, we do `npm install` dynamically from within this script 🎉.
+let core; // this will become lazily imported '@actions/core'
+
+main().catch(err => {
+  core && core.setFailed(err);
+  process.exit(1);
+});
+
+async function main() {
+  await install(['@actions/core']);
+  core = require('@actions/core');
+
+  await core.group('Install dependencies', installDependencies);
+  await core.group('Validate spec', validate);
+  await core.group('Publish to /TR/', publish);
+}
+
+async function installDependencies() {
+  await install(['respec', 'respec-validator']);
+}
+
+async function validate() {
+  const file = 'index.html';
+
+  if (!existsSync(file)) {
+    throw `❌ ${file} not found!`;
+  }
+
+  const ghUser = core.getInput('GH_USER');
+  const ghToken = core.getInput('GH_USER');
+
+  const validator = './node_modules/.bin/respec-validator';
+
+  if (!ghUser || !ghToken) {
+    await shell(validator, [file]);
+  } else {
+    await shell(validator, [
+      `--gh-user=${ghUser}`,
+      `--gh-token=${ghToken}`,
+      file
+    ]);
+  }
+}
+
+async function publish() {
+  // PUBLISH could be 'false' or '0' or 0 or something like that... sanity check
+  const shouldPublish = JSON.parse(`${core.getInput('PUBLISH')}`);
+  if (!shouldPublish) {
+    console.log('👻 Skipped.');
+    return;
+  }
+
+  console.log(
+    '💁‍♂️ If it fails, check https://lists.w3.org/Archives/Public/public-tr-notifications/'
+  );
+  const res = await request('https://labs.w3.org/echidna/api/request', {
+    method: 'POST',
+    body: JSON.stringify({
+      url: core.getInput('URL'),
+      decision: core.getInput('DECISION'),
+      token: core.getInput('ECHIDNA_TOKEN'),
+      cc: core.getInput('CC')
+    })
+  });
+  console.log(res);
+}
+
+// Utils
+
+function shell(command, args = [], options = {}) {
+  return new Promise((resolve, reject) => {
+    console.log(`💲 ${command} ${args.join(' ')}`);
+    const child = spawn(command, args, { stdio: 'inherit', ...options });
+    child.on('close', code => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(`❌ The process exited with status code: ${code}`);
+      }
+    });
+  });
+}
+
+async function install(dependencies) {
+  await shell('npm', ['install', '--quiet', ...dependencies]);
+}
+
+function request(url, options) {
+  return new Promise((resolve, reject) => {
+    const req = https.request(url, options, res => {
+      const chunks = [];
+      res.on('data', data => chunks.push(data));
+      res.on('end', () => {
+        let body = Buffer.concat(chunks);
+        if (res.headers['content-type'] === 'application/json') {
+          body = JSON.parse(body);
+        }
+        resolve(body);
+      });
+    });
+
+    req.on('error', reject);
+    if (options.body) req.write(options.body);
+    req.end();
+  });
+}