From 0fdc6270c847897309d166bde3e15e8a52f25262 Mon Sep 17 00:00:00 2001 From: Chris Hager Date: Thu, 12 Feb 2026 11:55:49 +0100 Subject: [PATCH] README: add info about CI / GitHub action --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 161b4e59..494ac333 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,33 @@ $ go install . or do `go build .` and run from the repository like `./builder-playground`. +## CI / GitHub Actions + +Use [`flashbots/builder-playground-action`](https://github.com/flashbots/builder-playground-action) to spin up devnets in your CI pipelines: + +```yaml +- name: Start Builder Playground + uses: flashbots/builder-playground-action@v1 + with: + recipe: l1 + +- name: Run tests + run: | + # Your tests here +``` + +You can also use a custom recipe file and pin a specific version: + +```yaml +- name: Start Builder Playground + uses: flashbots/builder-playground-action@v1 + with: + version: v1.0.0 + recipe: ./configs/my-recipe.yaml +``` + +See the [builder-playground-action README](https://github.com/flashbots/builder-playground-action) for full documentation. + ## Getting started See the available recipes from the `recipes` command: