relay-docs/.github/workflows/docs.yml at main · cachewerk/relay-docs · 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
52
53
name: Generate docs

on:
  schedule:
    - cron: '0 11 * * *' # 11:00 UTC, 03:00 PT, 06:00 ET
  workflow_dispatch:

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

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

jobs:

  deploy:

    name: API docs
    runs-on: ubuntu-latest
    timeout-minutes: 5

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:

      - name: Checkout develop branch
        uses: actions/checkout@v6

      - name: Install Composer dependencies
        run: composer install --no-interaction

      - name: Set up stubs
        run: composer run doctum:stubs

      - name: Generate API documentation
        run: ./vendor/bin/doctum.php update --force --no-ansi --no-progress --output-format=github -v doctum/config.php

      - name: Setup Pages
        uses: actions/configure-pages@v6

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: dist

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