Skip to content

Commit e8bca70

Browse files
committed
Clarify rendered docs artifact uploads
1 parent 02cd4d6 commit e8bca70

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

.github/workflows/build-docs.yml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,6 @@ jobs:
248248
fi
249249
mv ${COMPONENT}/docs/build/html/* artifacts/docs/${TARGET}
250250
251-
- name: Write doc preview marker
252-
if: ${{ !inputs.is-release && github.ref_name != 'main' && !startsWith(github.ref_name, 'release/') }}
253-
run: |
254-
echo "${{ github.sha }}" > artifacts/docs/.preview-commit
255-
256251
- name: Upload rendered docs for link checking
257252
if: ${{ !inputs.is-release && github.ref_name != 'main' && !startsWith(github.ref_name, 'release/') }}
258253
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
@@ -262,8 +257,9 @@ jobs:
262257
if-no-files-found: error
263258
retention-days: 3
264259

265-
# TODO: Consider removing this step?
266-
- name: Upload doc artifacts
260+
# This is the GitHub Pages artifact format; the link checker needs a
261+
# normal workflow artifact with the rendered HTML tree above.
262+
- name: Upload docs GitHub Pages artifact
267263
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
268264
with:
269265
path: artifacts/

0 commit comments

Comments
 (0)