Thanks to visit codestin.com
Credit goes to github.com

Skip to content
/ act Public
forked from nektos/act

Run your GitHub Actions locally πŸš€

License

Notifications You must be signed in to change notification settings

sravinet/act

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1,320 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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:

  • 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 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!

✨ Multi-Runtime Support

Act supports both Docker and Podman with automatic detection:

  • πŸ”’ Podman preferred for enhanced security (rootless, daemonless)
  • 🐳 Docker fallback for maximum compatibility
  • πŸ”„ Zero breaking changes - existing workflows continue to work

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 container runtime API (Docker or Podman) 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 container runtime 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

Container Runtime Support

Act supports multiple container runtimes with automatic detection and seamless switching:

πŸš€ Automatic Runtime Detection

Act automatically detects and uses the best available container runtime:

  1. πŸ”’ Podman preferred - Better security (rootless, no daemon required)
  2. 🐳 Docker fallback - Broader compatibility and mature tooling
  3. βš™οΈ User override - Full control via CLI flags or environment variables

Quick Start

# Automatic detection (Podman preferred if available)
act

# Force specific runtime
act --container-runtime=podman
act --container-runtime=docker

# Custom socket path  
act --container-socket=/run/user/$(id -u)/podman/podman.sock

Podman Installation

# macOS
brew install podman
podman machine init
podman machine start

# Ubuntu/Debian
sudo apt-get install podman

# Fedora/RHEL/CentOS  
sudo dnf install podman

macOS Note: Act automatically detects Podman machine sockets on macOS, including SSH-based connections. No manual configuration needed!

Configuration Options

CLI Flag Environment Variable Description
--container-runtime ACT_CONTAINER_RUNTIME Set runtime: auto, docker, podman
--container-socket ACT_CONTAINER_SOCKET Custom socket path

Benefits of Podman

  • πŸ” Enhanced Security: Rootless containers by default
  • 🚫 Daemonless: No background daemon required
  • ⚑ Better Performance: Lower resource overhead
  • 🐧 Linux Native: Better systemd integration

Zero Breaking Changes: All existing Docker workflows continue to work unchanged!

For detailed information, see Podman Support Documentation.

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

About

Run your GitHub Actions locally πŸš€

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 81.9%
  • JavaScript 16.7%
  • Shell 1.1%
  • Makefile 0.3%