act README

The project's README from github.com/nektos/act. As one markdown file: README.md.

act-logo

Overview push Go Report Card awesome-runners

"Think globally, act locally"

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

[!TIP] Now Manage and Run Act Directly From VS Code!
Check out the GitHub Local Actions Visual Studio Code extension which allows you to leverage the power of act to run and test workflows locally without leaving your editor.

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!

Demo

Act User Guide

Please look at the act user guide for more documentation.

Support

Need help? Ask in discussions!

Contributing

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

Manually building from source

act (nektos/act)

Searching Database…

72.4K ·GitHub
What is this?act lets you run your GitHub Actions workflows locally instead of pushing to GitHub every time to test a .github/workflows change.
Is it a CLI tool or something else?It is a command-line tool (written in Go) that also has an unofficial VS Code extension for running it from the editor.
How do I get it running?Install the act binary, then run it inside a repo that has a .github/workflows folder; it reads your workflow files and runs them.
Do I need Docker installed first?Yes, act uses the Docker API to pull or build the images defined in your workflow files and to run each action as a container.
Does it perfectly replicate GitHub's real runner environment?Not stated explicitly beyond that act configures environment variables and filesystem to match GitHub's, but it runs actions in local Docker containers rather than GitHub's actual hosted runners, so edge cases can differ.
Who is this useful for?Developers who want fast feedback on workflow changes without committing/pushing each time, or who want to reuse GitHub Actions definitions as a local task runner instead of a Makefile.
Can act replace my Makefile entirely?Yes, the author suggests using the GitHub Actions already defined in .github/workflows/ as your local task runner instead of maintaining a separate Makefile.
Creator
nektos
Size
17.3 MB
Stars
72.4K
Age
7y
Commits · 90 Days