mirror of
https://github.com/intel/llvm.git
synced 2026-01-26 21:53:12 +08:00
ba3bce0779
We were using the step security fork after the tj-actions/changed-files supply chain attack given Github disabled the repo and all our actions were failing during that time. Switch away from the fork back to the main repository to avoid an extra level of indirection until we can probably just stop using this action/roll our own.
216 lines
9.2 KiB
YAML
216 lines
9.2 KiB
YAML
# LLVM Documentation CI
|
|
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
# See https://llvm.org/LICENSE.txt for license information.
|
|
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
name: "Test documentation build"
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- 'main'
|
|
paths:
|
|
- 'llvm/docs/**'
|
|
- 'clang/docs/**'
|
|
- 'clang/include/clang/Basic/AttrDocs.td'
|
|
- 'clang/include/clang/Driver/ClangOptionDocs.td'
|
|
- 'clang/include/clang/Basic/DiagnosticDocs.td'
|
|
- 'clang-tools-extra/docs/**'
|
|
- 'lldb/docs/**'
|
|
- 'libunwind/docs/**'
|
|
- 'libcxx/docs/**'
|
|
- 'libc/docs/**'
|
|
- 'lld/docs/**'
|
|
- 'openmp/docs/**'
|
|
- 'polly/docs/**'
|
|
- 'flang/docs/**'
|
|
- 'flang/include/flang/Optimizer/Dialect/FIROps.td'
|
|
- '.github/workflows/docs.yml'
|
|
pull_request:
|
|
paths:
|
|
- 'llvm/docs/**'
|
|
- 'clang/docs/**'
|
|
- 'clang/include/clang/Basic/AttrDocs.td'
|
|
- 'clang/include/clang/Driver/ClangOptionDocs.td'
|
|
- 'clang/include/clang/Basic/DiagnosticDocs.td'
|
|
- 'clang-tools-extra/docs/**'
|
|
- 'lldb/docs/**'
|
|
- 'libunwind/docs/**'
|
|
- 'libcxx/docs/**'
|
|
- 'libc/docs/**'
|
|
- 'lld/docs/**'
|
|
- 'openmp/docs/**'
|
|
- 'polly/docs/**'
|
|
- 'flang/docs/**'
|
|
- 'flang/include/flang/Optimizer/Dialect/FIROps.td'
|
|
- '.github/workflows/docs.yml'
|
|
|
|
jobs:
|
|
check-docs-build:
|
|
name: "Test documentation build"
|
|
runs-on: ubuntu-24.04
|
|
if: github.repository == 'llvm/llvm-project'
|
|
steps:
|
|
- name: Fetch LLVM sources
|
|
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
|
with:
|
|
fetch-depth: 2
|
|
- name: Get subprojects that have doc changes
|
|
id: docs-changed-subprojects
|
|
uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46.0.5
|
|
with:
|
|
skip_initial_fetch: true
|
|
base_sha: 'HEAD~1'
|
|
sha: 'HEAD'
|
|
files_yaml: |
|
|
llvm:
|
|
- 'llvm/docs/**'
|
|
clang:
|
|
- 'clang/docs/**'
|
|
- 'clang/include/clang/Basic/AttrDocs.td'
|
|
- 'clang/include/clang/Driver/ClangOptionDocs.td'
|
|
- 'clang/include/clang/Basic/DiagnosticDocs.td'
|
|
clang-tools-extra:
|
|
- 'clang-tools-extra/docs/**'
|
|
lldb:
|
|
- 'lldb/docs/**'
|
|
libunwind:
|
|
- 'libunwind/docs/**'
|
|
libcxx:
|
|
- 'libcxx/docs/**'
|
|
libc:
|
|
- 'libc/docs/**'
|
|
lld:
|
|
- 'lld/docs/**'
|
|
openmp:
|
|
- 'openmp/docs/**'
|
|
polly:
|
|
- 'polly/docs/**'
|
|
flang:
|
|
- 'flang/docs/**'
|
|
- 'flang/include/flang/Optimizer/Dialect/FIROps.td'
|
|
workflow:
|
|
- '.github/workflows/docs.yml'
|
|
- name: Setup Python env
|
|
uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
|
|
with:
|
|
python-version: '3.11'
|
|
cache: 'pip'
|
|
cache-dependency-path: 'llvm/docs/requirements-hashed.txt'
|
|
- name: Install python dependencies
|
|
run: pip install -r llvm/docs/requirements-hashed.txt
|
|
- name: Install system dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
# swig and graphviz are lldb specific dependencies
|
|
sudo apt-get install -y cmake ninja-build swig graphviz
|
|
- name: Setup output folder
|
|
run: mkdir built-docs
|
|
- name: Build LLVM docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.llvm_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B llvm-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C llvm-build docs-llvm-html docs-llvm-man
|
|
mkdir built-docs/llvm
|
|
cp -r llvm-build/docs/* built-docs/llvm/
|
|
- name: Build Clang docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.clang_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C clang-build docs-clang-html docs-clang-man
|
|
mkdir built-docs/clang
|
|
cp -r clang-build/docs/* built-docs/clang/
|
|
- name: Build clang-tools-extra docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.clang-tools-extra_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B clang-tools-extra-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C clang-tools-extra-build docs-clang-tools-html docs-clang-tools-man
|
|
mkdir built-docs/clang-tools-extra
|
|
cp -r clang-tools-extra-build/docs/* built-docs/clang-tools-extra/
|
|
- name: Build LLDB docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.lldb_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B lldb-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;lldb" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C lldb-build docs-lldb-html docs-lldb-man
|
|
mkdir built-docs/lldb
|
|
cp -r lldb-build/docs/* built-docs/lldb/
|
|
- name: Build libunwind docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.libunwind_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B libunwind-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libunwind" -DLLVM_ENABLE_SPHINX=ON ./runtimes
|
|
TZ=UTC ninja -C libunwind-build docs-libunwind-html
|
|
mkdir built-docs/libunwind
|
|
cp -r libunwind-build/libunwind/docs/* built-docs/libunwind
|
|
- name: Build libcxx docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.libcxx_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B libcxx-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libcxxabi;libcxx;libunwind" -DLLVM_ENABLE_SPHINX=ON ./runtimes
|
|
TZ=UTC ninja -C libcxx-build docs-libcxx-html
|
|
mkdir built-docs/libcxx
|
|
cp -r libcxx-build/libcxx/docs/* built-docs/libcxx/
|
|
- name: Build libc docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.libc_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B libc-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libc" -DLLVM_ENABLE_SPHINX=ON ./runtimes
|
|
TZ=UTC ninja -C libc-build docs-libc-html
|
|
mkdir built-docs/libc
|
|
cp -r libc-build/libc/docs/* built-docs/libc/
|
|
- name: Build LLD docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.lld_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B lld-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="lld" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C lld-build docs-lld-html
|
|
mkdir built-docs/lld
|
|
cp -r lld-build/docs/* built-docs/lld/
|
|
- name: Build OpenMP docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.openmp_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B openmp-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;openmp" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C openmp-build docs-openmp-html
|
|
mkdir built-docs/openmp
|
|
cp -r openmp-build/docs/* built-docs/openmp/
|
|
- name: Build Polly docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.polly_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B polly-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="polly" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C polly-build docs-polly-html docs-polly-man
|
|
mkdir built-docs/polly
|
|
cp -r polly-build/docs/* built-docs/polly/
|
|
- name: Build Flang docs
|
|
if: |
|
|
steps.docs-changed-subprojects.outputs.flang_any_changed == 'true' ||
|
|
steps.docs-changed-subprojects.outputs.workflow_any_changed == 'true'
|
|
run: |
|
|
cmake -B flang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;mlir;flang" -DLLVM_ENABLE_SPHINX=ON ./llvm
|
|
TZ=UTC ninja -C flang-build docs-flang-html docs-flang-man
|
|
mkdir built-docs/flang
|
|
cp -r flang-build/docs/* built-docs/flang/
|
|
- name: Upload docs
|
|
uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
|
|
with:
|
|
name: docs-output
|
|
path: built-docs/
|