[llvm] [Github] Add lld to docs CI (PR #69821)

Aiden Grossman via llvm-commits llvm-commits at lists.llvm.org
Wed Oct 25 21:49:47 PDT 2023


https://github.com/boomanaiden154 updated https://github.com/llvm/llvm-project/pull/69821

>From 9dbe34c5c28a63c9097add4accf6a7f640119226 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 01:51:10 -0700
Subject: [PATCH 1/2] [Github] Add lld to docs CI

This patch adds the lld documentation to the documentation github
actions CI to automatically validate in PRs/at tip of tree that the docs
build and there aren't any Sphinx warnings. There is existing buildbot
coverage for the lld docs, but this much more convienient to use in
cases like PRs.
---
 .github/workflows/docs.yml | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index a0670625bb3e344..41e0622f74550a7 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -20,6 +20,7 @@ on:
       - 'libunwind/docs/**'
       - 'libcxx/docs/**'
       - 'libc/docs/**'
+      - 'lld/docs/**'
   pull_request:
     paths:
       - 'llvm/docs/**'
@@ -29,6 +30,7 @@ on:
       - 'libunwind/docs/**'
       - 'libcxx/docs/**'
       - 'libc/docs/**'
+      - 'lld/docs/**'
 
 jobs:
   check-docs-build:
@@ -63,6 +65,8 @@ jobs:
               - 'libcxx/docs/**'
             libc:
               - 'libc/docs/**'
+            lld:
+              - 'lld/docs/**'
       - name: Fetch LLVM sources (PR)
         if: ${{ github.event_name == 'pull_request' }}
         uses: actions/checkout at v4
@@ -116,4 +120,9 @@ jobs:
         run: |
           cmake -B libc-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libc" -DLLVM_ENABLE_SPHINX=ON ./runtimes
           TZ=UTC ninja -C docs-libc-html
+      - name: Build LLD docs
+        if: steps.docs-changed-subprojects.outputs.lld_any_changed == 'true'
+        run: |
+          cmake -B lld-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="lld" -DLLVM_ENABLE_SPHINX=ON -DSPHINX_OUTPUT_HTML=ON ./llvm
+          TZ=UTC ninja -C lld-build docs-lld-html
 

>From a06b8db5dc0e4ec9d89180b45899016c3c8e3d45 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 02:10:40 -0700
Subject: [PATCH 2/2] Remove cmake option resetting default value

---
 .github/workflows/docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 41e0622f74550a7..cbb3706cc1bcfec 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -123,6 +123,6 @@ jobs:
       - name: Build LLD docs
         if: steps.docs-changed-subprojects.outputs.lld_any_changed == 'true'
         run: |
-          cmake -B lld-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="lld" -DLLVM_ENABLE_SPHINX=ON -DSPHINX_OUTPUT_HTML=ON ./llvm
+          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
 



More information about the llvm-commits mailing list