Observable-Library/.github/workflows/docs.yml at main · MetaCircleAI/Observable-Library · 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
name: Docs

on:
  push:
    branches: [main]
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "observable_library/**"
      - "scripts/build_docs.py"
      - "tests/test_web_docs.py"
      - "pyproject.toml"
  pull_request:
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "observable_library/**"
      - "scripts/build_docs.py"
      - "tests/test_web_docs.py"
      - "pyproject.toml"
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: false

jobs:
  build:
    name: Build bilingual documentation
    runs-on: ubuntu-latest
    timeout-minutes: 8
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip
      - name: Install documentation dependencies
        run: python -m pip install -e ".[docs]"
      - name: Build GitHub Pages artifact
        run: python scripts/build_docs.py --output-dir build/web-docs
      - name: Run documentation policy tests
        run: python -m pytest tests/test_web_docs.py -q
      - name: Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: build/web-docs
          include-hidden-files: true

  deploy:
    name: Deploy GitHub Pages
    if: github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Configure GitHub Pages
        uses: actions/configure-pages@v6
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5