yume/act
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

documentation for .actrc

Browse source
This commit is contained in:
Casey Lee 2020-02-24 22:16:00 -08:00
parent 76a8bfc4fc
commit dadf8918be
No known key found for this signature in database
GPG key ID: 1899120ECD0A1784
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -51,7 +51,7 @@ act -n
act -v
```
# Platforms
# Runners
GitHub Actions offers managed [virtual environments](https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners) for running workflows. In order for `act` to run your workflows locally, it must run a container for the runner defined in your workflow file. Here are the images that `act` uses for each runner type:
| GitHub Runner | Docker Image |
@ -83,6 +83,14 @@ To run `act` with secrets, you can enter them interactively or supply them as en
* `act -s MY_SECRET=somevalue` - use `somevalue` as the value for `MY_SECRET`.
* `act -s MY_SECRET` - check for an environment variable named `MY_SECRET` and use it if it exists. If environment variable is not defined, prompt the user for a value.
# Configuration
You can provide default configuration flags to `act` by either creating a `./.actrc` or a `~/.actrc` file. Any flags in the files will be applied before any flags provided directly on the command line. For example, a file like below will always use the `nektos/act-environments-ubuntu:18.04` image for the `ubuntu-latest` runner:
```
# sample .actrc file
-P ubuntu-latest=nektos/act-environments-ubuntu:18.04
```
# Support
Need help? Ask on [Gitter](https://gitter.im/nektos/act)!