api-test/.github/workflows/deploy-api-docs.yml at main · regetz/api-test · 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
name: Deploy API Docs to GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      - 'api/openapi.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Validate OpenAPI spec
        run: npx @redocly/cli lint api/openapi.yml

      - name: Build API docs (HTML)
        run: npx @redocly/cli build-docs api/openapi.yml --output public/api/index.html

      - name: Copy assets for GitHub Pages
        run: |
          mkdir -p public/api/assets
          cp -R assets/* public/api/assets/

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: public

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4