Skip to content

Commit ba177a9

Browse files
authored
README: add info about CI / GitHub action (#368)
1 parent 0362d13 commit ba177a9

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,33 @@ $ go install .
3636

3737
or do `go build .` and run from the repository like `./builder-playground`.
3838

39+
## CI / GitHub Actions
40+
41+
Use [`flashbots/builder-playground-action`](https://github.com/flashbots/builder-playground-action) to spin up devnets in your CI pipelines:
42+
43+
```yaml
44+
- name: Start Builder Playground
45+
uses: flashbots/builder-playground-action@v1
46+
with:
47+
recipe: l1
48+
49+
- name: Run tests
50+
run: |
51+
# Your tests here
52+
```
53+
54+
You can also use a custom recipe file and pin a specific version:
55+
56+
```yaml
57+
- name: Start Builder Playground
58+
uses: flashbots/builder-playground-action@v1
59+
with:
60+
version: v1.0.0
61+
recipe: ./configs/my-recipe.yaml
62+
```
63+
64+
See the [builder-playground-action README](https://github.com/flashbots/builder-playground-action) for full documentation.
65+
3966
## Getting started
4067
4168
See the available recipes from the `recipes` command:

0 commit comments

Comments
 (0)