Skip to content

README.md

Latest commit

 

History

History
66 lines (47 loc) · 2.58 KB

README.md

File metadata and controls

66 lines (47 loc) · 2.58 KB
Raw

Forrest - A GitHub Action Runner Runner

                                    ┏━━━━━━━━━━━━━━━┓
                                    ┃      Run      ┃
                                    ┃    Forrest    ┃
                                    ┃      Run      ┃
                                    ┗━━━┯━━━━━━━┯━━━┛

Now you wouldn’t believe me if I told you, but I could run like the wind blows.
From that day on, if I was goin’ somewhere, I was runnin’!

Forrest talks to the GitHub API and spawns a virtual machine using QEMU/KVM whenever a runner is required to run an action.

This means Forrests helps you to:

  • Run actions on your own hardware, either because you need more powerful machines, want to run actions in your own network or want to cache artifacts locally.
  • Isolate action runs from one another and the hardware they are running on, allowing you to e.g. run actions for public repositories with pull requests from the community.

Example Users

Forrest Machine Image Generation

  • pengutronix/forrest-images

    Used at Pengutronix to derive Forrest machine images for Debos, PTXDist and Yocto from basic Debian cloud images.

Yocto Board Support Packages

Documentation

The documentation is split into multiple files:

  1. Acquiring operating system images suitable for use with Forrest:

  2. Registering a GitHub App for Forrest

  3. Writing a Forrest Config File

  4. Configuring nginx as Reverse Proxy

  5. Writing Workflow Jobs using Forrest

  6. Debugging Machines

                                    ┏━━━━━━━━━━━━━━┓
                                    ┃     Stop     ┃
                                    ┃    Forrest   ┃
                                    ┃     Stop     ┃
                                    ┗━━━┯━━━━━━┯━━━┛