sax/.github/workflows/docs.yml at 86f7d495aabcccb441db986f11f401b583d28b8b · gdsfactory/sax · 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
name: Docs
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main

jobs:

  run:
    name: Run Notebooks
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install UV
        uses: astral-sh/setup-uv@v5
      - name: Install Just
        uses: taiki-e/install-action@just
      - name: Run notebooks
        run: just dev nbrun
      - name: Upload artifacts [nbs]
        uses: actions/upload-artifact@v4
        with:
          name: nbs
          path: ./nbs

  docs:
    name: Build Docs
    runs-on: ubuntu-latest
    needs:
      - run
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Download artifacts [nbs]
        uses: actions/download-artifact@v4
        with:
          name: nbs
          path: ./nbs
      - name: Install UV
        uses: astral-sh/setup-uv@v5
      - name: Install Just
        uses: taiki-e/install-action@just
      - name: Build docs
        run: just dev nbdocs docs
      - name: Upload artifact [site]
        uses: actions/upload-pages-artifact@v3
        with:
          name: github-pages
          path: ./site

  pages:
    name: Deploy Docs
    runs-on: ubuntu-latest
    needs:
      - docs
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4