gha/README.md
Thomas Schoffelen 4f922d6c3f
Added README.
2018-12-31 18:15:57 +01:00

27 lines
490 B
Markdown

# GitHub Actions Tester
This Node application exposes an executable that allows you to test
your GitHub workflow locally using Docker.
## Installation
Install using [NPM](https://npmjs.com):
```
npm i -g gha
```
### Usage
```
Usage: gha [options]
Options:
-V, --version output the version number
-f <workflowfile> Set workflow file path, defaults to .github/main.workflow
-e <event> Set event, defaults to push
-h, --help output usage information
```