https://github.com/jellydn/github-action-locally
How to run GitHub Action locally with act.
https://github.com/jellydn/github-action-locally
act github-actions
Last synced: about 1 year ago
JSON representation
How to run GitHub Action locally with act.
- Host: GitHub
- URL: https://github.com/jellydn/github-action-locally
- Owner: jellydn
- Created: 2023-09-16T06:42:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T08:30:09.000Z (over 1 year ago)
- Last Synced: 2025-03-28T10:50:30.930Z (over 1 year ago)
- Topics: act, github-actions
- Language: TypeScript
- Homepage:
- Size: 12.7 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to github-action-locally 👋
How to run GitHub Action locally with `act`.
[![IT Man - Running GitHub Actions Locally: A Complete Guide with act [Vietnamese]](https://i.ytimg.com/vi/nklNK13G7u4/hqdefault.jpg)](https://www.youtube.com/watch?v=nklNK13G7u4)
## Sources
- [Bun — A fast all-in-one JavaScript runtime](https://bun.sh/)
- [Introduction - act - User Guide](https://nektosact.com/introduction.html)
- [OrbStack · Fast, light, simple Docker & Linux on macOS](https://orbstack.dev/)
## Prerequisites
- Docker or a compatible container engine (e.g., OrbStack, Podman)
- `act` installed. You can install it via Homebrew:
```bash
brew install act
```
## Usages
Clone your repository to your local machine:
```sh
gh repo clone jellydn/github-action-locally
```
Then run
```sh
bun install
```
### Basic Usage
Run all GitHub Action workflows defined in your `.github/workflows/` folder:
```bash
act
```
### List all jobs
```bash
act -l
```
### Running a Specific Job
Run a specific job from your workflow file:
```bash
act -j
```
### Using a Custom Runner
Specify a custom Docker image for the runner:
```bash
act -P =
```
Example:
```bash
act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04
```
### Using a Different Container Engine
If you prefer to use [Podman](https://podman-desktop.io/):
```bash
export DOCKER_HOST='unix:///var/run/podman/podman.sock'
act
```
Or, with a remote Docker engine:
```bash
DOCKER_HOST='ssh://user@host' act
```
Even though if you don't know where is the Docker socket, you can use the following:
```bash
docker context ls --format json | jq
```
Then you would have similar output:
```bash
{
"Current": false,
"Description": "Current DOCKER_HOST based configuration",
"DockerEndpoint": "unix:///var/run/docker.sock",
"Error": "",
"Name": "default"
}
{
"Current": true,
"Description": "OrbStack",
"DockerEndpoint": "unix:///Users/huynhdung/.orbstack/run/docker.sock",
"Error": "",
"Name": "orbstack"
}
```
## Troubleshooting
If you encounter issues, please refer to the official [`act` User Guide](https://nektosact.com/introduction.html) or open an issue in this repository.
## References
[![IT Man - Talk #34 - Bye Bye #Docker Desktop [Vietnamese]](https://i.ytimg.com/vi/llThjxFb7KU/mqdefault.jpg)](https://www.youtube.com/watch?v=llThjxFb7KU)
## Author
👤 **Huynh Duc Dung @jellydn**
- Website: https://productsway.com/
- Twitter: [@jellydn](https://twitter.com/jellydn)
- Github: [@jellydn](https://github.com/jellydn)
## Show your support
Give a ⭐️ if this project helped you!