valentine/.github/workflows/docs.yml at master · delftdata/valentine · 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
name: Documentation

on:
  push:
    branches:
      - master
  pull_request:
    paths:
      - "docs/**"
      - "zensical.toml"
      - ".github/workflows/docs.yml"
      - "pyproject.toml"
  workflow_dispatch:

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

# Only one concurrent deploy, cancelling in-progress runs.
concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-python@v5
        with:
          python-version: "3.x"
      - name: Install docs extras
        # Uses the pinned zensical version from pyproject.toml [docs] extra.
        run: pip install -e ".[docs]"
      - name: Build site
        run: zensical build --clean
      - name: Upload site artifact
        if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
        uses: actions/upload-pages-artifact@v4
        with:
          path: site

  deploy:
    # Only deploy on pushes to master (or manual dispatch), not on PRs.
    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/configure-pages@v5
      - uses: actions/deploy-pages@v4
        id: deployment