|
62 | 62 | - "src/pclient/**" |
63 | 63 | docs-specific: |
64 | 64 | - "docs/**" |
65 | | -
|
66 | | - docs: |
67 | | - runs-on: ubuntu-latest |
68 | | - timeout-minutes: 15 |
69 | | - |
70 | | - needs: changes |
71 | | - if: >- |
72 | | - (needs.changes.outputs.docs == 'true') |
73 | | - || (github.event_name == 'workflow_dispatch') |
74 | | - || (github.event_name == 'release' && github.event.action == 'published') |
75 | | -
|
76 | | - steps: |
77 | | - - uses: actions/checkout@v6 |
78 | | - with: |
79 | | - fetch-depth: 0 |
80 | | - |
81 | | - - name: Install uv |
82 | | - uses: astral-sh/setup-uv@v7 |
83 | | - with: |
84 | | - version: ${{ env.UV_VERSION }} |
85 | | - |
86 | | - - name: Install extra packages |
87 | | - run: | |
88 | | - sudo apt-get update |
89 | | - sudo apt-get install -y graphviz |
90 | | -
|
91 | | - - name: Run tox |
92 | | - run: uv run --only-group=tox tox run -e docs |
93 | | - |
94 | | - # Upload docs: |
95 | | - # - on pushes to main if *any* documentation content might have changed |
96 | | - # - on workflow dispatches |
97 | | - # - on pushes to tickets/ branches if docs/ directory content changed |
98 | | - - name: Upload to LSST the Docs |
99 | | - uses: lsst-sqre/ltd-upload@v1 |
100 | | - with: |
101 | | - project: "pclient" |
102 | | - dir: "docs/_build/html" |
103 | | - username: ${{ secrets.LTD_USERNAME }} |
104 | | - password: ${{ secrets.LTD_PASSWORD }} |
105 | | - if: >- |
106 | | - (github.event_name == 'push' && github.ref_name == 'main') |
107 | | - || (github.event_name == 'merge_group') |
108 | | - || (github.event_name == 'workflow_dispatch') |
109 | | - || (github.event_name == 'pull_request' |
110 | | - && (startsWith(github.head_ref, 'tickets/') |
111 | | - || startsWith(github.head_ref, 't/')) |
112 | | - && steps.filter.outputs.docs-specific == 'true') |
113 | | -
|
114 | | - linkcheck: |
115 | | - runs-on: ubuntu-latest |
116 | | - timeout-minutes: 15 |
117 | | - |
118 | | - needs: changes |
119 | | - if: ${{ needs.changes.outputs.docs == 'true' }} |
120 | | - |
121 | | - steps: |
122 | | - - uses: actions/checkout@v6 |
123 | | - with: |
124 | | - fetch-depth: 0 |
125 | | - |
126 | | - - name: Install uv |
127 | | - uses: astral-sh/setup-uv@v7 |
128 | | - with: |
129 | | - version: ${{ env.UV_VERSION }} |
130 | | - |
131 | | - - name: Install extra packages |
132 | | - run: | |
133 | | - sudo apt-get update |
134 | | - sudo apt-get install -y graphviz |
135 | | -
|
136 | | - - name: Run tox |
137 | | - run: uv run --only-group=tox tox run -e docs-linkcheck |
138 | | - |
139 | 65 | build: |
140 | 66 | needs: [test] |
141 | 67 | secrets: inherit |
|
0 commit comments