https://github.com/nektos/act

Run your GitHub Actions locally 🚀
https://github.com/nektos/act

ci devops github-actions golang

Last synced: 7 days ago
JSON representation

Run your GitHub Actions locally 🚀

• Host: GitHub
• URL: https://github.com/nektos/act
• Owner: nektos
• License: mit
• Created: 2019-01-02T19:53:43.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T00:12:33.000Z (5 months ago)
• Last Synced: 2024-05-29T14:21:22.205Z (5 months ago)
• Topics: ci, devops, github-actions, golang
• Language: Go
• Homepage: https://nektosact.com
• Size: 9.42 MB
• Stars: 51,088
• Watchers: 166
• Forks: 1,270
• Open Issues: 191
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-go - nektos/act
• awesome - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-github-actions - Act
• awesome - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-runners - nektos/act - P option](https://github.com/nektos/act#use-an-alternative-runner-image), see a more complex example [here](https://github.com/jonico/visualize-actions-matrix-builds-on-k8s/blob/master/simulate-action-workflow.sh). (Purpose / A word about self-hosted action runner images / virtual environments and how to test locally)
• my-awesome-list - act
• Self-Hosting-Guide - Act
• awesome-ops - nektos/act - 01-02|2024-10-01 | 本地运行 GitHub Actions | (CICD)
• awesome-actions - Run GitHub Actions Locally in Terminal
• fucking-awesome-actions - Run GitHub Actions Locally in Terminal
• awesome-ccamel - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-starred-test - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• my-awesome-starred - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-repositories - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-list - Act - Run your GitHub Actions locally (Github tools)
• go-awesome - act - run locally [GitHub Actions](https://developer.github.com/actions/) (Open source library / Developer)
• Fuchsia-Guide - Act
• awesome-list - act
• awesome-devtools - Act - Run github actions locally (Command line - Linux / Learning resources)
• awesome-workflows - Run GitHub Actions Locally in Terminal
• awesome-technative - Act - Run your GitHub Actions locally.[](https://badgen.net/github/stars/nektos/act) (Pipelines / Log Management)
• my-awesome - nektos/act - actions,golang pushed_at:2024-11 star:54.9k fork:1.4k Run your GitHub Actions locally 🚀 (Go)
• StarryDivineSky - nektos/act - 无需在每次要测试对 `.github/workflows/` 文件所做的更改（或对嵌入式 GitHub 操作的任何更改）时都提交/推送，而是可以在 `act` 本地运行操作。环境变量和文件系统都配置为与 GitHub 提供的内容相匹配。 (网络服务 / 网络服务_其他)
• jimsghstars - nektos/act - Run your GitHub Actions locally 🚀 (Go)
• awesome-modern-devops - Act - Run your GitHub Actions locally. (CI/CD)

README

        
![act-logo](https://raw.githubusercontent.com/wiki/nektos/act/img/logo-150.png)

# Overview [![push](https://github.com/nektos/act/workflows/push/badge.svg?branch=master&event=push)](https://github.com/nektos/act/actions) [![Join the chat at https://gitter.im/nektos/act](https://badges.gitter.im/nektos/act.svg)](https://gitter.im/nektos/act?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Go Report Card](https://goreportcard.com/badge/github.com/nektos/act)](https://goreportcard.com/report/github.com/nektos/act) [![awesome-runners](https://img.shields.io/badge/listed%20on-awesome--runners-blue.svg)](https://github.com/jonico/awesome-runners)

> "Think globally, `act` locally"

Run your [GitHub Actions](https://developer.github.com/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](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#filesystems-on-github-hosted-runners) 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](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#file-systems) are all configured to match what GitHub provides.

Let's see it in action with a [sample repo](https://github.com/cplee/github-actions-demo)!

![Demo](https://raw.githubusercontent.com/wiki/nektos/act/quickstart/act-quickstart-2.gif)

# Act User Guide

Please look at the [act user guide](https://nektosact.com) for more documentation.

# Support

Need help? Ask on [Gitter](https://gitter.im/nektos/act)!

# Contributing

Want to contribute to act? Awesome! Check out the [contributing guidelines](CONTRIBUTING.md) to get involved.

## Manually building from source

- Install Go tools 1.20+ - ()

- Clone this repo `git clone [email protected]:nektos/act.git`

- Run unit tests with `make test`

- Build and install: `make install`