Skip to content
/ gh-act Public

GitHub CLI Extension to run GitHub actions locally

License

Notifications You must be signed in to change notification settings

nektos/gh-act

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

act-logo

Overview

GitHub CLI Extension for nektos/act which allows you to run your GitHub Actions locally!

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

To learn more, check out the README.md for nektos/act.

Installation

To install, run: gh extension install nektos/gh-act