builder-playground/.github/workflows/checks.yaml at 07ab0861528df94d6edacfecbdd8ebd4df1524c4 · flashbots/builder-playground · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
name: Checks

on:
  workflow_dispatch:
  pull_request:
  merge_group:
  push:
    branches: [main]

jobs:
  e2e-test:
    name: E2E test (${{ matrix.flags }})
    runs-on: warp-ubuntu-latest-x64-8x
    strategy:
      matrix:
        flags:
          - "l1"
          - "l1 --use-native-reth"
          - "l1 --with-prometheus"
          - "opstack"
          - "opstack --external-builder http://host.docker.internal:4444"
          - "opstack --enable-latest-fork=0"
          - "opstack --enable-latest-fork=10"
    steps:
      - name: Check out code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.25

      - name: Install docker compose
        run: ./scripts/ci-setup-docker-compose.sh

      - name: Build playground utils
        run: ./scripts/ci-build-playground-utils.sh

      - name: Run playground
        run: go run main.go cook ${{ matrix.flags }} --output /tmp/playground --timeout 4m --watchdog

      - name: Copy playground logs
        if: ${{ failure() }}
        run: ./scripts/ci-copy-playground-logs.sh /tmp/playground /tmp/playground-logs

      - name: Archive playground logs
        uses: actions/upload-artifact@v4
        if: ${{ failure() }}
        with:
          name: playground-logs-${{ matrix.flags }}
          path: /tmp/playground-logs
          retention-days: 5

  unit-test:
    name: Unit test
    runs-on: warp-ubuntu-latest-x64-8x
    steps:
      - name: Check out code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.25

      - name: Install docker compose
        run: ./scripts/ci-setup-docker-compose.sh

      - name: Run unit tests
        run: go test -v ./playground/...

  integration-test:
    name: Integration test
    runs-on: warp-ubuntu-latest-x64-8x
    steps:
      - name: Check out code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.25

      - name: Install docker compose
        run: ./scripts/ci-setup-docker-compose.sh

      - name: Build playground utils
        run: ./scripts/ci-build-playground-utils.sh

      - name: Run unit tests
        run: make integration-test

  lint:
    name: Lint
    runs-on: warp-ubuntu-latest-x64-8x
    steps:
      - name: Check out code into the Go module directory
        uses: actions/checkout@v5

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version: 1.25

      - name: Download dependencies
        run: go mod download

      - name: Install gofumpt
        run: go install mvdan.cc/gofumpt@v0.6.0

      - name: Install staticcheck
        run: go install honnef.co/go/tools/cmd/staticcheck@2025.1.1

      - name: Install golangci-lint
        run: go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.2

      - name: Lint
        run: make lint

      - name: Ensure go mod tidy runs without changes
        run: |
          go mod tidy
          git update-index -q --really-refresh
          git diff-index HEAD

  docs-check:
    name: Check documentation is up to date
    runs-on: warp-ubuntu-latest-x64-8x
    steps:
      - name: Check out code
        uses: actions/checkout@v2

      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: 1.25

      - name: Generate documentation
        run: make generate-docs

      - name: Check for uncommitted changes
        run: |
          git update-index -q --really-refresh
          git diff-index --quiet HEAD -- docs/recipes/ || (echo "Documentation is out of date. Please run 'go run main.go generate-docs' and commit the changes." && exit 1)