Repository files navigation

"Think globally,act locally"

Run yourGitHub Actions locally! Why would you want to do this? Two reasons:

• Fast Feedback - Rather than having to commit/push every time you want to test out the changes you are making to your.github/workflows/ files (or for any changes to embedded GitHub actions), you can useact to run the actions locally. Theenvironment variables andfilesystem are all configured to match what GitHub provides.
• Local Task Runner - I lovemake. However, I also hate repeating myself. Withact, you can use the GitHub Actions defined in your.github/workflows/ to replace yourMakefile!

When you runact 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. Theenvironment variables andfilesystem are all configured to match what GitHub provides.

Let's see it in action with asample repo!

Please look at theact user guide for more documentation.

Need help? Ask onGitter!

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

• Install Go tools 1.20+ - (https://golang.org/doc/install)
• Clone this repogit clone git@github.com:nektos/act.git
• Run unit tests withmake test
• Build and install:make install