Skip to content
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

[Github] Add lld to docs CI #69821

Merged
merged 2 commits into from Oct 26, 2023
Merged

Conversation

boomanaiden154
Copy link
Contributor

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.

@boomanaiden154
Copy link
Contributor Author

There is a lld man page somewhere, but there doesn't seem to be a docs-lld-man target or anything equivalent. Is this something that's buildable?

@llvmbot
Copy link
Collaborator

llvmbot commented Oct 21, 2023

@llvm/pr-subscribers-github-workflow

Author: Aiden Grossman (boomanaiden154)

Changes

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.


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

1 Files Affected:

  • (modified) .github/workflows/docs.yml (+9)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 8eadd382398089a..2ed659772e8e533 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -15,10 +15,12 @@ on:
     paths:
       - 'llvm/docs/**'
       - 'clang/docs/**'
+      - 'lld/docs/**'
   pull_request:
     paths:
       - 'llvm/docs/**'
       - 'clang/docs/**'
+      - 'lld/docs/**'
 
 jobs:
   check-docs-build:
@@ -47,6 +49,8 @@ jobs:
               - 'llvm/docs/**'
             clang:
               - 'clang/docs/**'
+            lld:
+              - 'lld/docs/**'
       - name: Setup Python env
         uses: actions/setup-python@v4
         with:
@@ -69,4 +73,9 @@ jobs:
         run: |
           cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON -DSPHINX_OUTPUT_HTML=ON -DSPHINX_OUTPUT_MAN=ON ./llvm
           TZ=UTC ninja -C clang-build docs-clang-html docs-clang-man
+      - 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
 

@tstellar
Copy link
Collaborator

There is a lld man page somewhere, but there doesn't seem to be a docs-lld-man target or anything equivalent. Is this something that's buildable?

The man page is just a static text file. It's not generated.

Copy link
Collaborator

@tstellar tstellar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

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.
@boomanaiden154 boomanaiden154 merged commit 68d993e into llvm:main Oct 26, 2023
3 checks passed
zahiraam pushed a commit to zahiraam/llvm-project that referenced this pull request Oct 26, 2023
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.
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.

None yet

4 participants