chore: Update OpenAPI spec build workflow

ProjectLibertyLabs · Jul 24, 2024 · 4c0f580 · 4c0f580
1 parent 0fc38cc
commit 4c0f580
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 24 deletions.
diff --git a/.github/workflows/common/openapi-build/action.yaml b/.github/workflows/common/openapi-build/action.yaml
@@ -1,11 +1,11 @@
 name: Build and Publish OpenAPI UI
+description: "Build and publish OpenAPI UI for a service"
 
-on:
-  workflow_call:
-    inputs:
-      service:
-        required: true
-        type: string
+inputs:
+  service:
+    description: "The name of the service to build OpenAPI UI for"
+    required: true
+    type: string
 
 runs:
   using: "composite"

diff --git a/.github/workflows/deploy-gh-pages.yaml b/.github/workflows/deploy-gh-pages.yaml
@@ -47,7 +47,7 @@ jobs:
       # Upload the mdBook output to GitHub Pages
       - name: Upload mdbook to GitHub Pages
         if: matrix.service == 'account' # Only upload mdbook once
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: mdbook
           path: ./docs/book
@@ -66,6 +66,7 @@ jobs:
 
   # Deployment job
   deploy:
+    name: Deploy mdbook and OpenAPI microservices to GitHub Pages
     runs-on: ubuntu-latest
     needs: build
     environment:
@@ -76,34 +77,34 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Download mdbook artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: mdbook
           path: ./docs/book
 
       - name: Download account OpenAPI artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: openapi-account
           path: ./docs/account
 
-      - name: Download content-watcher OpenAPI artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: openapi-content-watcher
-          path: ./docs/content-watcher
+      # - name: Download content-watcher OpenAPI artifacts
+      #   uses: actions/download-artifact@v4
+      #   with:
+      #     name: openapi-content-watcher
+      #     path: ./docs/content-watcher
 
-      - name: Download content-publishing OpenAPI artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: openapi-content-publishing
-          path: ./docs/content-publishing
+      # - name: Download content-publishing OpenAPI artifacts
+      #   uses: actions/download-artifact@v4
+      #   with:
+      #     name: openapi-content-publishing
+      #     path: ./docs/content-publishing
 
-      - name: Download graph OpenAPI artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: openapi-graph
-          path: ./docs/graph
+      # - name: Download graph OpenAPI artifacts
+      #   uses: actions/download-artifact@v4
+      #   with:
+      #     name: openapi-graph
+      #     path: ./docs/graph
 
       - name: Deploy to GitHub Pages
         id: deployment