Skip to content

Commit 4c0f580

Browse files
committed
chore: Update OpenAPI spec build workflow
1 parent 0fc38cc commit 4c0f580

File tree

2 files changed

+25
-24
lines changed

2 files changed

+25
-24
lines changed

.github/workflows/common/openapi-build/action.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
name: Build and Publish OpenAPI UI
2+
description: "Build and publish OpenAPI UI for a service"
23

3-
on:
4-
workflow_call:
5-
inputs:
6-
service:
7-
required: true
8-
type: string
4+
inputs:
5+
service:
6+
description: "The name of the service to build OpenAPI UI for"
7+
required: true
8+
type: string
99

1010
runs:
1111
using: "composite"

.github/workflows/deploy-gh-pages.yaml

+19-18
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
# Upload the mdBook output to GitHub Pages
4848
- name: Upload mdbook to GitHub Pages
4949
if: matrix.service == 'account' # Only upload mdbook once
50-
uses: actions/upload-artifact@v3
50+
uses: actions/upload-artifact@v4
5151
with:
5252
name: mdbook
5353
path: ./docs/book
@@ -66,6 +66,7 @@ jobs:
6666

6767
# Deployment job
6868
deploy:
69+
name: Deploy mdbook and OpenAPI microservices to GitHub Pages
6970
runs-on: ubuntu-latest
7071
needs: build
7172
environment:
@@ -76,34 +77,34 @@ jobs:
7677
uses: actions/checkout@v4
7778

7879
- name: Download mdbook artifact
79-
uses: actions/download-artifact@v3
80+
uses: actions/download-artifact@v4
8081
with:
8182
name: mdbook
8283
path: ./docs/book
8384

8485
- name: Download account OpenAPI artifacts
85-
uses: actions/download-artifact@v3
86+
uses: actions/download-artifact@v4
8687
with:
8788
name: openapi-account
8889
path: ./docs/account
8990

90-
- name: Download content-watcher OpenAPI artifacts
91-
uses: actions/download-artifact@v3
92-
with:
93-
name: openapi-content-watcher
94-
path: ./docs/content-watcher
91+
# - name: Download content-watcher OpenAPI artifacts
92+
# uses: actions/download-artifact@v4
93+
# with:
94+
# name: openapi-content-watcher
95+
# path: ./docs/content-watcher
9596

96-
- name: Download content-publishing OpenAPI artifacts
97-
uses: actions/download-artifact@v3
98-
with:
99-
name: openapi-content-publishing
100-
path: ./docs/content-publishing
97+
# - name: Download content-publishing OpenAPI artifacts
98+
# uses: actions/download-artifact@v4
99+
# with:
100+
# name: openapi-content-publishing
101+
# path: ./docs/content-publishing
101102

102-
- name: Download graph OpenAPI artifacts
103-
uses: actions/download-artifact@v3
104-
with:
105-
name: openapi-graph
106-
path: ./docs/graph
103+
# - name: Download graph OpenAPI artifacts
104+
# uses: actions/download-artifact@v4
105+
# with:
106+
# name: openapi-graph
107+
# path: ./docs/graph
107108

108109
- name: Deploy to GitHub Pages
109110
id: deployment

0 commit comments

Comments
 (0)