CONTRIBUTING.md

Contributing

Code in Master

Install the dependencies

$ npm install

Build the typescript

$ npm run build

Run the tests ✔️

$ npm test

> [email protected] test /Users/lee/Source/lee-dohm/close-matching-issues
> jest

 PASS  __tests__/main.test.ts
  ✓ fails when no token is supplied (160ms)
  ✓ fails when no query is supplied (125ms)

...

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 switch -c releases/v1
$ git commit -a -m "Production dependencies"

$ npm prune --production
$ git add node_modules
$ git commit -a -m "Production 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