nws-hpc-standards/.github/workflows/docs.yaml at 75ba656af7944a5fced0e3ba0f536f3cc59c60e2 · NCO-HPC/nws-hpc-standards · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
name: docs
on:
  push:
    branches:
      - develop
      - feature/*
      - main/*
      - bugfix/*
      - release/*
    paths:
      - docs/**
  pull_request_target:
    types: [issues, opened, reopened, synchronize]
    paths:
      - docs/**
  workflow_dispatch:
    inputs:
      branch:
        description: 'Branch to build documentation for'
        required: false
        default: 'develop'
      commit:
        description: 'Commit to build documentation for'
        required: false
        default: 'HEAD'

jobs:

  documentation:

    permissions:
      pull-requests: "write"

    runs-on: ubuntu-latest
    name: Build and deploy documentation

    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Setup Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.13"

    - name: Install (upgrade) python dependencies
      run: |
        pip install --upgrade pip
        pip install -r docs/requirements.txt

    - name: Install (upgrade) latex dependencies
      run: |
        sudo apt-get update
        sudo apt-get install texlive-latex-base
        sudo apt-get install texlive-fonts-recommended texlive-fonts-extra
        sudo apt-get install texlive-latex-extra
        sudo apt-get install latexmk

    - name: Build documentation
      run: |
        cd docs
        make html
        make latexpdf

    - name: Upload documentation (on success)
      uses: actions/upload-artifact@v4
      if: success()
      with:
        name: ee-docs.pdf
        path: docs/_build/latex/ee-docs.pdf
        if-no-files-found: ignore

#    - name: Upload warnings (on failure)
#      uses: actions/upload-artifact@v4
#      if: failure()
#      with:
#        name: ee-docs.warnings.log
#        path: docs/_build/warnings.log
#        if-no-files-found: ignore
#
    - name: Comment ReadDocs Link in PR
#      if: ${{ github.event_name == 'pull_request' }}
      uses: actions/github-script@v7
      with:
        script: |
          const message = `
          Link to ReadTheDocs sample build for this PR can be found at:
          https://nws-hpc-standards--${{ github.event.pull_request.number }}.org.readthedocs.build/en/${{ github.event.pull_request.number }}
          `
          github.rest.issues.createComment({
           issue_number: context.pull_request.number,
           owner: context.repo.owner,
           repo: context.repo.repo,
           body: message
          })