Hyperlex/.github/workflows/docs.yml at main · Zero-State-LLC/Hyperlex · 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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
name: Docs (MkDocs)

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"
      - "scripts/sync_mkdocs_pages.py"
      - "README.md"
      - "ARCHITECTURE.md"
      - "DESIGN.md"
      - "SPEC.md"
      - "STATUS.md"
      - "ROADMAP.md"
      - "CONTRIBUTING.md"
  pull_request:
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "scripts/sync_mkdocs_pages.py"
      - "STATUS.md"
      - "ROADMAP.md"
      - "CONTRIBUTING.md"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

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

concurrency:
  group: pages-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Install docs deps
        run: pip install -U pip "mkdocs>=1.5,<2" "mkdocs-material>=9.0"
      - name: Sync root pages into docs/
        run: |
          cp ARCHITECTURE.md docs/architecture.md
          cp DESIGN.md docs/design.md
          cp SPEC.md docs/spec.md
          cp STATUS.md docs/status.md
          cp ROADMAP.md docs/ROADMAP.md
          cp CONTRIBUTING.md docs/contributing.md
          python3 scripts/sync_mkdocs_pages.py
      - name: Build site (strict)
        run: mkdocs build --strict
      - name: Upload artifact
        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4