cpp_client_telemetry/.github/workflows/deploy-docs-pages.yml at main · microsoft/cpp_client_telemetry · 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
73
74
75
76
77
78
name: Deploy documentation to GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      - .github/workflows/deploy-docs-pages.yml
      - .readthedocs.yaml
      - docs/**
      - lib/include/**
  pull_request:
    paths:
      - .github/workflows/deploy-docs-pages.yml
      - .readthedocs.yaml
      - docs/**
      - lib/include/**
  workflow_dispatch:

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

concurrency:
  group: github-pages
  cancel-in-progress: false

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-24.04

    steps:
      - name: Check out repository
        uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0

      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: "3.12"

      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --yes doxygen graphviz

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/public/requirements.txt

      - name: Build Sphinx documentation
        run: python -m sphinx -q -b html docs/public docs/public/_build/html

      - name: Upload Pages artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
        with:
          path: docs/public/_build/html

  deploy:
    name: Deploy documentation
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-24.04

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Configure GitHub Pages
        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5