Merge branch 'main' into release-please--branches--main--components--…

…blobstorage

.github/workflows/bridge-ui-ci.yml → .github/workflows/bridge-ui--ci.yml

@@ -1,7 +1,6 @@
 name: Bridge UI Build and Checks
 
-on:
-  workflow_call
+on: workflow_call
 
 jobs:
   build:

.github/workflows/eventindexer.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   lint-eventindexer:
-    name: lint
+    name: lint-eventindexer
     runs-on: [taiko-runner]
     steps:
       - uses: actions/setup-go@v5
@@ -30,7 +30,7 @@ jobs:
 
   test-eventindexer:
     runs-on: [taiko-runner]
-    needs: lint
+    needs: lint-eventindexer
     steps:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]

.github/workflows/guardians-ui.yml → .github/workflows/guardian-prover-health-check-ui.yml

@@ -20,8 +20,8 @@ jobs:
     needs: build-and-test
     uses: ./.github/workflows/vercel-deploy.yml
     with:
-          environment: 'preview'
-          flags: ''
+      environment: "preview"
+      flags: ""
     secrets:
       vercel_project_id: ${{ secrets.VERCEL_PROJECT_ID_GUARDIAN_UI_HEKLA }}
       vercel_org_id: ${{ secrets.VERCEL_ORG_ID }}
@@ -32,8 +32,8 @@ jobs:
     needs: build-and-test
     uses: ./.github/workflows/vercel-deploy.yml
     with:
-          environment: 'preview'
-          flags: ''
+      environment: "preview"
+      flags: ""
     secrets:
       vercel_project_id: ${{ secrets.VERCEL_PROJECT_ID_GUARDIAN_UI_INTERNAL }}
       vercel_org_id: ${{ secrets.VERCEL_ORG_ID }}
@@ -44,8 +44,8 @@ jobs:
     needs: build-and-test
     uses: ./.github/workflows/vercel-deploy.yml
     with:
-      environment: 'production'
-      flags: '--prod'
+      environment: "production"
+      flags: "--prod"
     secrets:
       vercel_project_id: ${{ secrets.VERCEL_PROJECT_ID_GUARDIAN_UI_HEKLA }}
       vercel_org_id: ${{ secrets.VERCEL_ORG_ID }}

.github/workflows/guardians-health-check.yaml → .github/workflows/guardian-prover-health-check.yml

@@ -10,8 +10,8 @@ on:
       - "packages/guardian-prover-health-check/**"
 
 jobs:
-  lint:
-    name: lint
+  lint-guardian-prover-health-check:
+    name: lint-guardian-prover-health-check
     runs-on: [taiko-runner]
     steps:
       - uses: actions/setup-go@v5
@@ -28,9 +28,9 @@ jobs:
           working-directory: ./packages/guardian-prover-health-check
           args: --config=.golangci.yml --timeout=4m
 
-  test:
+  test-guardian-prover-health-check:
     runs-on: [taiko-runner]
-    needs: lint
+    needs: lint-guardian-prover-health-check
     steps:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]
@@ -52,7 +52,7 @@ jobs:
           files: ./packages/guardian-prover-health-check/coverage.txt
           flags: guardian-prover-health-check
 
-  push-docker-image:
+  push-guardian-prover-health-check-docker-image:
     # only push docker image on PR merge to main
     if: ${{ github.event }} == 'push'
     name: Build and push docker image

.github/workflows/relayer.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   lint-relayer:
-    name: lint
+    name: lint-relayer
     runs-on: [taiko-runner]
     steps:
       - uses: actions/setup-go@v5
@@ -30,7 +30,7 @@ jobs:
 
   test-relayer:
     runs-on: [taiko-runner]
-    needs: lint
+    needs: lint-relayer
     steps:
       - name: Cancel Previous Runs
         uses: styfle/[email protected]

.github/workflows/vercel-deploy.yml → .github/workflows/repo--vercel-deploy.yml

@@ -11,18 +11,18 @@ on:
         required: true
     secrets:
       vercel_project_id:
-        description: 'Vercel Project ID'
+        description: "Vercel Project ID"
         required: true
       vercel_org_id:
-        description: 'Vercel ORG ID'
+        description: "Vercel ORG ID"
         required: true
       vercel_token:
-        description: 'Vercel TOKEN'
+        description: "Vercel TOKEN"
         required: true
 
 env:
-    VERCEL_ORG_ID: ${{ secrets.vercel_org_id }}
-    VERCEL_PROJECT_ID: ${{ secrets.vercel_project_id }}
+  VERCEL_ORG_ID: ${{ secrets.vercel_org_id }}
+  VERCEL_PROJECT_ID: ${{ secrets.vercel_project_id }}
 
 jobs:
   build-deploy:

.github/workflows/taikoon-ui-ci.yml → .github/workflows/taikoon-ui--ci.yml

@@ -1,7 +1,6 @@
 name: Taikoon UI Build and Checks
 
-on:
-  workflow_call
+on: workflow_call
 
 jobs:
   build:

.release-please-manifest.json

@@ -2,7 +2,7 @@
   "packages/blobstorage": "0.2.0",
   "packages/branding": "0.4.0",
   "packages/bridge-ui": "2.10.1",
-  "packages/docs-site": "1.0.0",
+  "packages/docs-site": "1.1.0",
   "packages/eventindexer": "0.13.0",
   "packages/fork-diff": "0.5.0",
   "packages/guardian-prover-health-check": "0.1.0",

packages/docs-site/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.0](https://github.com/taikoxyz/taiko-mono/compare/docs-site-v1.0.0...docs-site-v1.1.0) (2024-05-14)
+
+
+### Features
+
+* **repo,docs-site:** migrate swagger apis to docs ([#17149](https://github.com/taikoxyz/taiko-mono/issues/17149)) ([1b3baf6](https://github.com/taikoxyz/taiko-mono/commit/1b3baf637ecd7103b5918dccb67cd9defc57511e))
+
 ## [1.0.0](https://github.com/taikoxyz/taiko-mono/compare/docs-site-v1.0.0...docs-site-v1.0.0) (2024-05-13)
 
 

packages/docs-site/astro.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
 import starlightLinksValidator from "starlight-links-validator";
+import starlightOpenAPI, { openAPISidebarGroups } from "starlight-openapi";
 
 // https://astro.build/config
 export default defineConfig({
@@ -13,7 +14,38 @@ export default defineConfig({
   },
   integrations: [
     starlight({
-      plugins: [starlightLinksValidator()],
+      plugins: [
+        starlightLinksValidator({
+          exclude: [
+            // "/api-reference/blob-storage",
+            "/api-reference/bridge-relayer",
+            "/api-reference/event-indexer",
+            "/api-reference/prover-server",
+          ],
+        }),
+        starlightOpenAPI([
+          // {
+          //   base: "api-reference/blob-storage",
+          //   label: "Blob Storage API",
+          //   schema: "../blobstorage/docs/swagger.yaml",
+          // },
+          {
+            base: "api-reference/bridge-relayer",
+            label: "Bridge Relayer API",
+            schema: "../relayer/docs/swagger.yaml",
+          },
+          {
+            base: "api-reference/event-indexer",
+            label: "Event Indexer API",
+            schema: "../eventindexer/docs/swagger.yaml",
+          },
+          {
+            base: "api-reference/prover-server",
+            label: "Prover Server API",
+            schema: "../taiko-client/docs/swagger.yaml",
+          },
+        ]),
+      ],
       components: {
         SiteTitle: "./src/components/starlight/SiteTitle.astro",
         Head: "./src/components/starlight/Head.astro",
@@ -115,14 +147,14 @@ export default defineConfig({
             },
           ],
         },
-        {
-          label: "API Reference",
-          autogenerate: { directory: "api-reference" },
-        },
         {
           label: "Resources",
           autogenerate: { directory: "resources" },
         },
+        {
+          label: "API Reference",
+          items: openAPISidebarGroups,
+        },
       ],
     }),
   ],