jenkinsapi/.github/workflows/build-docs.yml at eb78bcae3f5958edc193dff300597e3bfce56e75 · pycontribs/jenkinsapi · 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
name: Sphinx build

on:  # yamllint disable-line rule:truthy
  push:
    branches:
      - master
  workflow_dispatch:

permissions:
  contents: read

jobs:
  sphinx-build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pages: write
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@6c3c2f2c1c457b00c10c4848d6f5491db3b629df # v2.18.0
        with:
          egress-policy: audit
          # azure.archive.ubuntu.com:80           - Ubuntu apt packages
          # esm.ubuntu.com:443                    - Ubuntu ESM security updates
          # files.pythonhosted.org:443            - Python package downloads
          # github.com:443                        - Git operations / Actions
          # api.github.com:443                    - GitHub API
          # int.api.stepsecurity.io:443           - harden-runner telemetry
          # motd.ubuntu.com:443                   - Ubuntu MOTD
          # packages.microsoft.com:443            - Microsoft apt repo (ubuntu-latest runner)
          # ppa.launchpadcontent.net:443          - Ubuntu PPA
          # pypi.org:443                          - PyPI package index
          # objects.githubusercontent.com:443     - GitHub release artifacts / LFS
          allowed-endpoints: >
            azure.archive.ubuntu.com:80
            esm.ubuntu.com:443
            files.pythonhosted.org:443
            github.com:443
            api.github.com:443
            int.api.stepsecurity.io:443
            motd.ubuntu.com:443
            packages.microsoft.com:443
            ppa.launchpadcontent.net:443
            pypi.org:443
            objects.githubusercontent.com:443

      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Install uv
        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0

      - name: Install dependencies
        run: |
          sudo apt-get update; sudo apt-get install libkrb5-dev gcc

      - name: Build HTML
        run: make
        working-directory: ./doc

      - name: Upload artifacts
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: html-docs
          path: ./doc/html/

      - name: Deploy Master Docs to GitHub Pages
        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./doc/html
          publish_branch: gh-pages
          keep_files: false