Skip to content

Conversation

@boomanaiden154
Copy link
Contributor

This patch adds a step to build the lldb docs when they change to the Github docs action, enabling easy triage of warnings/docs build failures during the PR process.

@llvmbot
Copy link
Member

llvmbot commented Oct 21, 2023

@llvm/pr-subscribers-github-workflow

Author: Aiden Grossman (boomanaiden154)

Changes

This patch adds a step to build the lldb docs when they change to the Github docs action, enabling easy triage of warnings/docs build failures during the PR process.


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

1 Files Affected:

  • (modified) .github/workflows/docs.yml (+11-1)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2900f73c77c5a66..b750d8728f65c89 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,10 +15,12 @@ on: paths: - 'llvm/docs/**' - 'clang/docs/**' + - 'lldb/docs/**' pull_request: paths: - 'llvm/docs/**' - 'clang/docs/**' + - 'lldb/docs/**' jobs: check-docs-build: @@ -47,6 +49,8 @@ jobs: - 'llvm/docs/**' clang: - 'clang/docs/**' + lldb: + - 'lldb/docs/**' - name: Setup Python env uses: actions/setup-python@v4 with: @@ -58,7 +62,8 @@ jobs: - name: Install system dependencies run: | sudo apt-get update - sudo apt-get install -y cmake ninja-build + # swig and graphviz are lldb specific dependencies + sudo apt-get install -y cmake ninja-build swig graphviz - name: Build LLVM docs if: steps.docs-changed-subprojects.outputs.llvm_any_changed == 'true' run: | @@ -69,4 +74,9 @@ jobs: 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 + - name: Build LLDB docs + if: steps.docs-changed-subprojects.outputs.lldb_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 
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.

Copy link
Member

@JDevlieghere JDevlieghere left a comment

Choose a reason for hiding this comment

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

Awesome!

This patch adds a step to build the lldb docs when they change to the Github docs action, enabling easy triage of warnings/docs build failures during the PR process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

4 participants