|
| 1 | +name: Generate OpenAPI Specs |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + branches: |
| 6 | + - master |
| 7 | + - np-integrate-open-api-spex |
| 8 | + paths-ignore: |
| 9 | + - "CHANGELOG.md" |
| 10 | + - "**/README.md" |
| 11 | + - "docker/*" |
| 12 | + - "docker-compose/*" |
| 13 | + workflow_dispatch: |
| 14 | + release: |
| 15 | + types: [published] |
| 16 | + |
| 17 | +env: |
| 18 | + OTP_VERSION: '27.3.4.6' |
| 19 | + ELIXIR_VERSION: '1.19.4' |
| 20 | + RELEASE_VERSION: 10.0.7 |
| 21 | + |
| 22 | +jobs: |
| 23 | + matrix-builder: |
| 24 | + name: Build matrix |
| 25 | + runs-on: ubuntu-latest |
| 26 | + outputs: |
| 27 | + matrix: ${{ steps.set-matrix.outputs.matrix }} |
| 28 | + steps: |
| 29 | + - id: set-matrix |
| 30 | + run: | |
| 31 | + echo "matrix=$(node -e ' |
| 32 | +
|
| 33 | + // Add/remove CI matrix chain types here |
| 34 | + const chainTypes = [ |
| 35 | + "default", |
| 36 | + "arbitrum", |
| 37 | + "blackfort", |
| 38 | + "ethereum", |
| 39 | + "filecoin", |
| 40 | + "optimism", |
| 41 | + "optimism-celo", |
| 42 | + "polygon_zkevm", |
| 43 | + "rsk", |
| 44 | + "scroll", |
| 45 | + "shibarium", |
| 46 | + "stability", |
| 47 | + "zetachain", |
| 48 | + "zilliqa", |
| 49 | + "zksync", |
| 50 | + "neon" |
| 51 | + ]; |
| 52 | +
|
| 53 | + const matrix = { "chain-type": ${{ 'chainTypes' }} }; |
| 54 | + console.log(JSON.stringify(matrix)); |
| 55 | + ')" >> $GITHUB_OUTPUT |
| 56 | +
|
| 57 | + build-and-cache: |
| 58 | + name: Build and Cache deps |
| 59 | + runs-on: ubuntu-latest |
| 60 | + steps: |
| 61 | + - uses: actions/checkout@v5 |
| 62 | + - uses: erlef/setup-beam@v1 |
| 63 | + with: |
| 64 | + otp-version: ${{ env.OTP_VERSION }} |
| 65 | + elixir-version: ${{ env.ELIXIR_VERSION }} |
| 66 | + hexpm-mirrors: | |
| 67 | + https://builds.hex.pm |
| 68 | + https://cdn.jsdelivr.net/hex |
| 69 | +
|
| 70 | + - name: "ELIXIR_VERSION.lock" |
| 71 | + run: echo "${ELIXIR_VERSION}" > ELIXIR_VERSION.lock |
| 72 | + |
| 73 | + - name: "OTP_VERSION.lock" |
| 74 | + run: echo "${OTP_VERSION}" > OTP_VERSION.lock |
| 75 | + |
| 76 | + - name: Restore Mix Deps Cache |
| 77 | + uses: actions/cache@v4 |
| 78 | + id: deps-cache |
| 79 | + with: |
| 80 | + path: | |
| 81 | + deps |
| 82 | + _build |
| 83 | + key: ${{ runner.os }}-${{ env.ELIXIR_VERSION }}-${{ env.OTP_VERSION }}-${{ env.MIX_ENV }}-deps-mixlockhash-${{ hashFiles('mix.lock') }} |
| 84 | + restore-keys: | |
| 85 | + ${{ runner.os }}-${{ env.ELIXIR_VERSION }}-${{ env.OTP_VERSION }}-${{ env.MIX_ENV }}-deps-mixlockhash- |
| 86 | +
|
| 87 | + - name: Conditionally build Mix deps cache |
| 88 | + if: steps.deps-cache.outputs.cache-hit != 'true' |
| 89 | + run: | |
| 90 | + mix local.hex --force |
| 91 | + mix local.rebar --force |
| 92 | + mix deps.get |
| 93 | + mix deps.compile --skip-umbrella-children |
| 94 | +
|
| 95 | + generate-swagger: |
| 96 | + strategy: |
| 97 | + fail-fast: false |
| 98 | + matrix: ${{ fromJson(needs.matrix-builder.outputs.matrix) }} |
| 99 | + name: Generate Open API spec |
| 100 | + runs-on: ubuntu-latest |
| 101 | + needs: |
| 102 | + - build-and-cache |
| 103 | + - matrix-builder |
| 104 | + steps: |
| 105 | + - uses: actions/checkout@v5 |
| 106 | + - uses: erlef/setup-beam@v1 |
| 107 | + with: |
| 108 | + otp-version: ${{ env.OTP_VERSION }} |
| 109 | + elixir-version: ${{ env.ELIXIR_VERSION }} |
| 110 | + hexpm-mirrors: | |
| 111 | + https://builds.hex.pm |
| 112 | + https://cdn.jsdelivr.net/hex |
| 113 | +
|
| 114 | + - name: Mix Deps Cache |
| 115 | + uses: actions/cache/restore@v4 |
| 116 | + id: deps-cache |
| 117 | + with: |
| 118 | + path: | |
| 119 | + deps |
| 120 | + _build |
| 121 | + key: ${{ runner.os }}-${{ env.ELIXIR_VERSION }}-${{ env.OTP_VERSION }}-${{ env.MIX_ENV }}-deps-mixlockhash-${{ hashFiles('mix.lock') }} |
| 122 | + restore-keys: | |
| 123 | + ${{ runner.os }}-${{ env.ELIXIR_VERSION }}-${{ env.OTP_VERSION }}-${{ env.MIX_ENV }}-deps-mixlockhash- |
| 124 | +
|
| 125 | + - name: mix openapi.spec.yaml |
| 126 | + run: | |
| 127 | + mix openapi.spec.yaml --spec BlockScoutWeb.Specs.Public openapi.${{ matrix.chain-type }}.yaml --start-app=false |
| 128 | + env: |
| 129 | + CHAIN_TYPE: ${{ matrix.chain-type != 'default' && matrix.chain-type || '' }} |
| 130 | + MUD_INDEXER_ENABLED: false |
| 131 | + |
| 132 | + - name: Generate MUD-enabled spec for Optimism |
| 133 | + if: matrix.chain-type == 'optimism' |
| 134 | + run: | |
| 135 | + mix openapi.spec.yaml --spec BlockScoutWeb.Specs.Public openapi.mud.yaml --start-app=false |
| 136 | + env: |
| 137 | + CHAIN_TYPE: optimism |
| 138 | + MUD_INDEXER_ENABLED: true |
| 139 | + |
| 140 | + - name: Upload OpenAPI spec |
| 141 | + uses: actions/upload-artifact@v4 |
| 142 | + with: |
| 143 | + name: openapi-spec-${{ matrix.chain-type }} |
| 144 | + path: openapi.${{ matrix.chain-type }}.yaml |
| 145 | + retention-days: 1 |
| 146 | + |
| 147 | + - name: Upload MUD-enabled spec |
| 148 | + if: matrix.chain-type == 'optimism' |
| 149 | + uses: actions/upload-artifact@v4 |
| 150 | + with: |
| 151 | + name: openapi-spec-mud |
| 152 | + path: openapi.mud.yaml |
| 153 | + retention-days: 1 |
| 154 | + |
| 155 | + push-specs: |
| 156 | + needs: |
| 157 | + - generate-swagger |
| 158 | + - matrix-builder |
| 159 | + runs-on: ubuntu-latest |
| 160 | + name: Push all OpenAPI specs |
| 161 | + steps: |
| 162 | + - name: Validate required secrets |
| 163 | + run: | |
| 164 | + if [ -z "${{ secrets.API_SPECS_PAT }}" ]; then |
| 165 | + echo "Error: API_SPECS_PAT secret is not set" |
| 166 | + exit 1 |
| 167 | + fi |
| 168 | +
|
| 169 | + - name: Checkout specs repository |
| 170 | + uses: actions/checkout@v5 |
| 171 | + with: |
| 172 | + repository: ${{ vars.API_SPECS_REPOSITORY }} |
| 173 | + token: ${{ secrets.API_SPECS_PAT }} |
| 174 | + path: api-specs |
| 175 | + |
| 176 | + - name: Download all swagger specs |
| 177 | + uses: actions/download-artifact@v5 |
| 178 | + with: |
| 179 | + pattern: openapi-spec-* |
| 180 | + merge-multiple: true |
| 181 | + path: temp-specs |
| 182 | + |
| 183 | + - name: Create specs directory structure |
| 184 | + run: | |
| 185 | + VERSION=${{ github.event_name == 'release' && env.RELEASE_VERSION || 'master' }} |
| 186 | +
|
| 187 | + for SPEC_FILE in temp-specs/*; do |
| 188 | + if [ -f "$SPEC_FILE" ]; then |
| 189 | + FILENAME=$(basename "$SPEC_FILE") |
| 190 | + |
| 191 | + # Handle MUD spec specially |
| 192 | + if [ "$FILENAME" = "openapi.mud.yaml" ]; then |
| 193 | + mkdir -p "api-specs/blockscout/${VERSION}/mud" |
| 194 | + cp "$SPEC_FILE" "api-specs/blockscout/${VERSION}/mud/swagger.yaml" |
| 195 | + else |
| 196 | + # Extract chain type from filename (openapi.CHAINTYPE.yaml) |
| 197 | + CHAIN_TYPE=$(echo "$FILENAME" | sed 's/openapi\.\(.*\)\.yaml/\1/') |
| 198 | + mkdir -p "api-specs/blockscout/${VERSION}/${CHAIN_TYPE}" |
| 199 | + cp "$SPEC_FILE" "api-specs/blockscout/${VERSION}/${CHAIN_TYPE}/swagger.yaml" |
| 200 | + fi |
| 201 | + fi |
| 202 | + done |
| 203 | +
|
| 204 | +
|
| 205 | + - name: Commit and push changes |
| 206 | + working-directory: api-specs |
| 207 | + run: | |
| 208 | + git config --local user.email "github-actions[bot]@users.noreply.github.com" |
| 209 | + git config --local user.name "github-actions[bot]" |
| 210 | + |
| 211 | + git add . |
| 212 | +
|
| 213 | + # Only commit if there are changes |
| 214 | + if git diff --staged --quiet; then |
| 215 | + echo "No changes to commit" |
| 216 | + else |
| 217 | + git commit -m "[SKIP-GH-PAGES] create OpenAPI specs for Blockscout ${{ github.event_name == 'release' && env.RELEASE_VERSION || github.sha }}" |
| 218 | + git push |
| 219 | + fi |
| 220 | +
|
| 221 | + - name: Clean up |
| 222 | + if: always() |
| 223 | + run: | |
| 224 | + rm -rf temp-specs |
| 225 | + rm -rf api-specs |
0 commit comments