teachLink_backend/.github/workflows/api-docs.yml at main · rinafcode/teachLink_backend · 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
name: API Docs

on:
  push:
    branches: [main]
    paths:
      - 'src/**/*.ts'
      - 'scripts/generate-api-docs.js'
      - 'package.json'
      - 'package-lock.json'
      - 'docs/api/**'
      - '.github/workflows/api-docs.yml'
  workflow_dispatch:

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

concurrency:
  group: api-docs-pages
  cancel-in-progress: true

jobs:
  build:
    name: Generate API Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: npm
      - run: npm ci
      - run: npm run docs:generate
      - uses: actions/configure-pages@v5
      - uses: actions/upload-pages-artifact@v3
        with:
          path: docs/site

  deploy:
    name: Deploy API Docs
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4