HCL syntax disclaimer on README

Signed-off-by: Casey Lee <cplee@nektos.com>
This commit is contained in:
Casey Lee 2019-10-31 11:59:33 -07:00
parent fd6fe1872f
commit 76b1c6a3f1
No known key found for this signature in database
GPG Key ID: 1899120ECD0A1784
1 changed files with 2 additions and 0 deletions

View File

@ -4,6 +4,8 @@
> "Think globally, <code>act</code> locally"
__Currently this library only supports the HCL syntax, not the YAML syntax__
Run your [GitHub Actions](https://developer.github.com/actions/) locally! Why would you want to do this? Two reasons:
* **Fast Feedback** - Rather than having to commit/push every time you want test out the changes you are making to your `.github/workflows/` files (or for any changes to embedded GitHub actions), you can use `act` to run the actions locally. The [environment variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#filesystems-on-github-hosted-runners) are all configured to match what GitHub provides.