Go to file

Casey Lee 5b7019cd0b skip unsupported platforms Signed-off-by: Casey Lee <cplee@nektos.com>		2020-02-20 21:06:01 -05:00
.github	add funding.yml	2020-02-20 21:05:51 -05:00
cmd	skip unsupported platforms	2020-02-20 21:06:01 -05:00
pkg	skip unsupported platforms	2020-02-20 21:06:01 -05:00
vendor	expressions working	2020-02-20 21:05:55 -05:00
.editorconfig	Initial commit with support for GitHub actions	2019-01-12 20:45:25 -08:00
.gitignore	Initial commit with support for GitHub actions	2019-01-12 20:45:25 -08:00
.golangci.yml	test updates	2020-02-20 21:05:44 -05:00
.goreleaser.yml	fail on error (#20 )	2019-01-23 11:51:22 -08:00
CONTRIBUTING.md	Initial commit with support for GitHub actions	2019-01-12 20:45:25 -08:00
LICENSE	Initial commit	2019-01-02 11:53:43 -08:00
Makefile	fix tests	2020-02-20 21:05:57 -05:00
README.md	merge master	2020-02-20 21:05:53 -05:00
go.mod	expressions working	2020-02-20 21:05:55 -05:00
go.sum	expressions working	2020-02-20 21:05:55 -05:00
install.sh	Initial commit with support for GitHub actions	2019-01-12 20:45:25 -08:00
main.go	Initial commit with support for GitHub actions	2019-01-12 20:45:25 -08:00

README.md

Overview

"Think globally, act locally"

Run your GitHub 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 and filesystem are all configured to match what GitHub provides.
Local Task Runner - I love make. However, I also hate repeating myself. With act, you can use the GitHub Actions defined in your .github/workflows/ to replace your Makefile!

How Does It Work?

When you run act it reads in your GitHub Actions from .github/workflows/ and determines the set of actions that need to be run. It uses the Docker API to either pull or build the necessary images, as defined in your workflow files and finally determines the execution path based on the dependencies that were defined. Once it has the execution path, it then uses the Docker API to run containers for each action based on the images prepared earlier. The environment variables and filesystem are all configured to match what GitHub provides.

Let's see it in action with a sample repo!

Installation

To install with Homebrew, run:

brew install nektos/tap/act

Alternatively, you can use the following:

curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash

If you are running Arch Linux, you can install the act package with your favorite package manager:

yay -S act

Commands

# List the actions
act -l

# Run the default (`push`) event:
act

# Run a specific event:
act pull_request

# Run a specific job:
act -j test

# Run in dry-run mode:
act -n

# Run in reuse mode to save state:
act -r

# Enable verbose-logging (can be used with any of the above commands)
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 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. 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!

Contributing

Want to contribute to act? Awesome! Check out the contributing guidelines to get involved.

Building from source

Install Go tools 1.11.4+ - (https://golang.org/doc/install)
Clone this repo git clone git@github.com:nektos/act.git
Run unit tests with make check
Build and install: make install