dfetch/.github/workflows/docs.yml at 181fdaddd6d6534c28ed99f01e7e4cec0fd51f3b · dfetch-org/dfetch · 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
name: "Docs"

on:
  workflow_call:

permissions:
  contents: read

jobs:
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
    - name: Harden the runner (Audit all outbound calls)
      uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
      with:
        egress-policy: audit

    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1

    - name: Install Python
      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
      with:
        python-version: '3.13'

    - name: Install documentation requirements
      run: |
          pip install .[docs]
          pip install sphinx_design

    - name: Build docs
      run: "make -C doc html"

  landing-page:
    name: Landing page
    runs-on: ubuntu-latest
    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
        with:
          egress-policy: audit

      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1

      - name: Setup Python
        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
        with:
          python-version: "3.13"

      - name: Install dependencies
        run: |
          pip install .[docs]
          pip install sphinx_design

      - name: Build landing-page
        run: "make -C doc/landing-page html"

      - name: Publish
        if: github.ref == 'refs/heads/main'
        uses: tsunematsu21/actions-publish-gh-pages@c04b531c52b8f9d25c596bc6e6a7ddc116b2f3f8 # v1.0.2
        with:
          dir: doc/landing-page/_build/html
          repo: dfetch-org/dfetch-org.github.io
          branch: main
          token: ${{ secrets.GH_DFETCH_ORG_DEPLOY }}