https://github.com/phishy/wflow

🐆 EXPERIMENTAL -- Runs GitHub Actions workflows locally (local) -- Don't run your YAML like a 🐪
https://github.com/phishy/wflow

ci continuous-deployment continuous-integration devops docker docker-container github-actions javascript local-development workflow yaml

Last synced: 5 days ago
JSON representation

🐆 EXPERIMENTAL -- Runs GitHub Actions workflows locally (local) -- Don't run your YAML like a 🐪

• Host: GitHub
• URL: https://github.com/phishy/wflow
• Owner: phishy
• License: mit
• Created: 2019-09-14T21:31:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T15:59:21.000Z (about 2 years ago)
• Last Synced: 2025-04-03T01:12:33.312Z (12 days ago)
• Topics: ci, continuous-deployment, continuous-integration, devops, docker, docker-container, github-actions, javascript, local-development, workflow, yaml
• Language: JavaScript
• Homepage:
• Size: 4.32 MB
• Stars: 252
• Watchers: 4
• Forks: 7
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Run GitHub Actions Locally with a web interface
• fucking-awesome-actions - Run GitHub Actions Locally with a web interface
• awesome-workflows - Run GitHub Actions Locally with a web interface

README

        
![](screenshot.png)

[![Join the chat at https://gitter.im/wflow-local/community](https://badges.gitter.im/wflow-local/community.svg)](https://gitter.im/wflow-local/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

![Codecov](https://img.shields.io/codecov/c/github/phishy/wflow)

## Requirements

* Docker

* Node.js

## Install

`npm install -g wflow`

## Usage

`wflow`

Running that should give you a preview of how it works, however likely you'll want to specify a workflow file, dude.

Point wflow at a valid YAML file. You may also specify an event (a GitHub webhook payload). If you do not provide an event, it attempts to read from .git.

`wflow --file build.yml --event event.json`

## How It Works

GitHub Actions uses Azure Pipeline to spin up real VMs that you request with `runs-on`. As this is running locally, we are using docker-in-docker. We'll see how this goes.

When you run the `wflow`, it spins up a lightweight API and UI server. It reads the workflow syntax, and runs docker containers performing the work. Sidecar syslogs are setup for each docker container in order to capture the logs and write them to your `workspace`. Each jobs gets its own workspace. Each step in a job operates on the same workspace.  While log files are written to disk, they are simultanously broadcast over WebSocker so that the UI can consume them. The UI needs some work.

## Workflow Syntax

https://help.github.com/en/articles/workflow-syntax-for-github-actions

### Currently supported

* `name`

* `jobs`

* `jobs.`

* `jobs..name`

* `jobs..needs`

* `jobs..runs-on` (ubuntu-latest only)

* `jobs..steps`

Currently, only Docker-based actions are supported. PRs welcome for JavaScript-based actions.

### Not yet supported

* `on`

* `on.schedule`

* `jobs..timeout-minutes`

* `jobs..strategy`

* `jobs..container`

* `jobs..services`

## Install for Development

The following installs dependencies in `node_modules` and links `wflow` to work globally.

`./install.sh`