Initial commit

Author: csexton

.eslintrc.json

@@ -0,0 +1,17 @@
+{
+    "env": {
+        "commonjs": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "rules": {
+    }
+}

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: "test-local"
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - 'releases/*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+
+    - run: npm ci
+    - run: npm test
+    - uses: ./
+      with:
+        milliseconds: 1000

.gitignore

@@ -0,0 +1,66 @@
+# comment this out distribution branches
+node_modules/
+
+# Editors
+.vscode
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Other Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 GitHub Actions
+
+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,113 @@
+
+<p align="center">
+  <a href="https://github.com/actions/javascript-action"><img alt="GitHub Actions status" src="https://github.com/actions/javascript-action/workflows/test-local/badge.svg"></a>
+</p>
+
+# Create a JavaScript Action
+
+Use this template to bootstrap the creation of a JavaScript action.:rocket:
+
+This template includes tests, linting, a validation workflow, publishing, and versioning guidance.  
+
+If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+
+## Create an action from this template
+
+Click the `Use this Template` and provide the new repo details for your action
+
+## Code in Master
+
+Install the dependencies  
+```bash
+$ npm install
+```
+
+Run the tests :heavy_check_mark:  
+```bash
+$ npm test
+
+ PASS  ./index.test.js
+  ✓ throws invalid number (3ms)
+  ✓ wait 500 ms (504ms)
+  ✓ test runs (95ms)
+
+...
+```
+
+## Change action.yml
+
+The action.yml contains defines the inputs and output for your action.
+
+Update the action.yml with your name, description, inputs and outputs for your action.
+
+See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
+
+## Change the Code
+
+Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
+
+```javascript
+const core = require('@actions/core');
+...
+
+async function run() {
+  try { 
+      ...
+  } 
+  catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run()
+```
+
+See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
+
+## Publish to a distribution branch
+
+Actions are run from GitHub repos.  We will create a releases branch and only checkin production modules (core in this case). 
+
+Comment out node_modules in .gitignore and create a releases/v1 branch
+```bash
+# comment this out distribution branches
+# node_modules/
+```
+
+```bash
+$ git checkout -b releases/v1
+$ git commit -a -m "prod dependencies"
+```
+
+```bash
+$ npm prune --production
+$ git add node_modules
+$ git commit -a -m "prod dependencies"
+$ git push origin releases/v1
+```
+
+Your action is now published! :rocket: 
+
+See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
+
+## Validate
+
+You can now validate the action by referencing the releases/v1 branch
+
+```yaml
+uses: actions/javascript-action@releases/v1
+with:
+  milliseconds: 1000
+```
+
+See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
+
+## Usage:
+
+After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and tested action
+
+```yaml
+uses: actions/javascript-action@v1
+with:
+  milliseconds: 1000
+```

action.yml

@@ -0,0 +1,13 @@
+name: 'Wait'
+description: 'Wait a designated number of milliseconds'
+inputs:
+  milliseconds:  # id of input
+    description: 'number of milliseconds to wait'
+    required: true
+    default: '1000'
+outputs:
+  time: # output will be available to future steps 
+    description: 'The message to output'
+runs:
+  using: 'node12'
+  main: 'index.js'

index.js

@@ -0,0 +1,22 @@
+const core = require('@actions/core');
+const wait = require('./wait');
+
+
+// most @actions toolkit packages have async methods
+async function run() {
+  try { 
+    const ms = core.getInput('milliseconds');
+    console.log(`Waiting ${ms} milliseconds ...`)
+
+    core.debug((new Date()).toTimeString())
+    wait(parseInt(ms));
+    core.debug((new Date()).toTimeString())
+
+    core.setOutput('time', new Date().toTimeString());
+  } 
+  catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run()

index.test.js

@@ -0,0 +1,23 @@
+const wait = require('./wait');
+const process = require('process');
+const cp = require('child_process');
+const path = require('path');
+
+test('throws invalid number', async() => {
+    await expect(wait('foo')).rejects.toThrow('milleseconds not a number');
+});
+
+test('wait 500 ms', async() => {
+    const start = new Date();
+    await wait(500);
+    const end = new Date();
+    var delta = Math.abs(end - start);
+    expect(delta).toBeGreaterThan(450);
+});
+
+// shows how the runner will run a javascript action with env / stdout protocol
+test('test runs', () => {
+    process.env['INPUT_MILLISECONDS'] = 500;
+    const ip = path.join(__dirname, 'index.js');
+    console.log(cp.execSync(`node ${ip}`).toString());
+})