diff --git a/README.md b/README.md index 842f4463..accaa007 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,17 @@ act -r act -v ``` +# Secrets + +To run `act` with secrets, you can enter them interactively or supply them as environment variables. +If you have a secret called `FOO` in your `main.workflow`, `act` will take whatever you have set as `FOO` in the session from which you are running `act`. +If `FOO` is unset, it will ask you interactively. + +You can set environment variables for the current session by running `export FOO="zap"`, or globally in your `.profile`. +You can also set environment variables *per directory* using a tool such as [direnv](https://direnv.net/). +**Be careful not to expose secrets**: +You may want to `.gitignore` any files or folders containing secrets, and/or encrypt secrets. + # Support Need help? Ask on [Gitter](https://gitter.im/nektos/act)!