Skip to content

README: add info about CI / GitHub action #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
canercidam merged 1 commit into from
Feb 12, 2026
Merged

README: add info about CI / GitHub action #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down