Skip to content

[Github] Test docs action on workflow changes #119627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

boomanaiden154
Copy link
Contributor

This patch makes the check docs build workflow run testing on all of the docs builds when the workflow is changed. This is intended to catch issues like those that were not caught premerge when adding in the functionality to download the built docs.

This patch makes the check docs build workflow run testing on all of the docs
builds when the workflow is changed. This is intended to catch issues like
those that were not caught premerge when adding in the functionality to
download the built docs.
@boomanaiden154 boomanaiden154 force-pushed the docs-workflow-better-testing branch from bd78637 to 77d38e4 Compare December 11, 2024 22:59
@boomanaiden154 boomanaiden154 marked this pull request as ready for review December 11, 2024 23:03
@llvmbot
Copy link
Member

llvmbot commented Dec 11, 2024

@llvm/pr-subscribers-github-workflow

Author: Aiden Grossman (boomanaiden154)

Changes

This patch makes the check docs build workflow run testing on all of the docs builds when the workflow is changed. This is intended to catch issues like those that were not caught premerge when adding in the functionality to download the built docs.


Full diff: https://github.com/llvm/llvm-project/pull/119627.diff

1 Files Affected:

  • (modified) .github/workflows/docs.yml (+35-11)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 0bb018b780a2a1..8441589bb716e0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -94,6 +94,8 @@ jobs:
             flang:
               - 'flang/docs/**'
               - 'flang/include/flang/Optimizer/Dialect/FIROps.td'
+            workflow:
+              - '.github/workflows/docs.yml'
       - name: Fetch LLVM sources (PR)
         if: ${{ github.event_name == 'pull_request' }}
         uses: actions/checkout@v4
@@ -115,77 +117,99 @@ jobs:
       - name: Setup output folder
         run: mkdir built-docs
       - name: Build LLVM docs
-        if: steps.docs-changed-subprojects.outputs.llvm_any_changed == 'true'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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'
+        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

@boomanaiden154 boomanaiden154 merged commit 5747ad4 into llvm:main Dec 13, 2024
10 checks passed
@boomanaiden154 boomanaiden154 deleted the docs-workflow-better-testing branch December 13, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants