Skip to content
No description, website, or topics provided.
JavaScript TypeScript
Branch: master
Clone or download
Latest commit dd85ee5 Sep 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows run local action Sep 21, 2019
__tests__ update with tests Sep 21, 2019
lib update with tests Sep 21, 2019
src update with tests Sep 21, 2019
.gitignore update with tests Sep 21, 2019
LICENSE New toolkit Jul 22, 2019
README.md update readme Sep 21, 2019
action.yml update yml info (#16) Sep 11, 2019
jest.config.js New toolkit Jul 22, 2019
package-lock.json Update dependencies Aug 20, 2019
package.json update with tests Sep 21, 2019
tsconfig.json Allow implicit any for octokit Jul 31, 2019

README.md

Create a JavaScript Action using TypeScript

Use this template to bootstrap the creation of a JavaScript action.🚀

This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance.

If you are new, there's also a simpler introduction. See the 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

$ npm install

Build the typescript

$ npm run build

Run the tests ✔️

$ 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

Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

import * as core from '@actions/core';
...

async function run() {
  try { 
      ...
  } 
  catch (error) {
    core.setFailed(error.message);
  }
}

run()

See the toolkit documentation 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

# comment out in distribution branches
# node_modules/
$ git checkout -b releases/v1
$ git commit -a -m "prod dependencies"
$ npm prune --production
$ git add node_modules
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Your action is now published! 🚀

See the versioning documentation

Validate

You can now validate the action by referencing the releases/v1 branch

uses: actions/typescript-action@releases/v1
with:
  milliseconds: 1000

See the actions tab for runs of this action! 🚀

Usage:

After testing you can create a v1 tag to reference the stable and tested action

uses: actions/typescript-action@v1
with:
  milliseconds: 1000
You can’t perform that action at this time.