From 7ef5e767846f8e58368a5ba300457d3ec43c1d1a Mon Sep 17 00:00:00 2001 From: stevhliu Date: Tue, 14 Oct 2025 22:33:35 -0700 Subject: [PATCH 1/4] check links --- .../workflows/check_documentation_links.yml | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/check_documentation_links.yml diff --git a/.github/workflows/check_documentation_links.yml b/.github/workflows/check_documentation_links.yml new file mode 100644 index 000000000000..2f195c6b6b49 --- /dev/null +++ b/.github/workflows/check_documentation_links.yml @@ -0,0 +1,49 @@ +name: Check Documentation Links + +on: + pull_request: + paths: + - "src/diffusers/**.py" + - "examples/**" + - "docs/**" + push: + branches: + - main + - doc-builder* + - v*-release + - v*-patch + paths: + - "src/diffusers/**.py" + - "examples/**" + - "docs/**" + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + check-links: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + + - name: Install uv + run: | + curl -LsSf https://astral.sh/uv/install.sh | sh + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + + - name: Install doc-builder + run: | + uv pip install --system git+https://github.com/huggingface/doc-builder.git@main + + - name: Check documentation links + run: | + uv run doc-builder check-links docs/source From 4601633a5a810c3c84b00e590d12d9aec77e108c Mon Sep 17 00:00:00 2001 From: stevhliu Date: Tue, 14 Oct 2025 22:44:05 -0700 Subject: [PATCH 2/4] update --- .github/workflows/check_documentation_links.yml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/workflows/check_documentation_links.yml b/.github/workflows/check_documentation_links.yml index 2f195c6b6b49..064640d625a7 100644 --- a/.github/workflows/check_documentation_links.yml +++ b/.github/workflows/check_documentation_links.yml @@ -3,8 +3,6 @@ name: Check Documentation Links on: pull_request: paths: - - "src/diffusers/**.py" - - "examples/**" - "docs/**" push: branches: @@ -13,8 +11,6 @@ on: - v*-release - v*-patch paths: - - "src/diffusers/**.py" - - "examples/**" - "docs/**" workflow_dispatch: @@ -46,4 +42,4 @@ jobs: - name: Check documentation links run: | - uv run doc-builder check-links docs/source + uv run doc-builder check-links docs/source/en From 184aa8972b38d44481d9470000c3de0452cb2fda Mon Sep 17 00:00:00 2001 From: stevhliu Date: Wed, 15 Oct 2025 09:00:50 -0700 Subject: [PATCH 3/4] feedback --- .github/workflows/build_pr_documentation.yml | 26 ++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/.github/workflows/build_pr_documentation.yml b/.github/workflows/build_pr_documentation.yml index 52e075733163..f47645c1f659 100644 --- a/.github/workflows/build_pr_documentation.yml +++ b/.github/workflows/build_pr_documentation.yml @@ -12,7 +12,33 @@ concurrency: cancel-in-progress: true jobs: + check-links: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + + - name: Install uv + run: | + curl -LsSf https://astral.sh/uv/install.sh | sh + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + + - name: Install doc-builder + run: | + uv pip install --system git+https://github.com/huggingface/doc-builder.git@main + + - name: Check documentation links + run: | + uv run doc-builder check-links docs/source/en + build: + needs: check-links uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main with: commit_sha: ${{ github.event.pull_request.head.sha }} From 9a89ecff3f30dafb53b82d36d9ab4087d4b687f7 Mon Sep 17 00:00:00 2001 From: stevhliu Date: Thu, 16 Oct 2025 09:22:28 -0700 Subject: [PATCH 4/4] remove --- .../workflows/check_documentation_links.yml | 45 ------------------- 1 file changed, 45 deletions(-) delete mode 100644 .github/workflows/check_documentation_links.yml diff --git a/.github/workflows/check_documentation_links.yml b/.github/workflows/check_documentation_links.yml deleted file mode 100644 index 064640d625a7..000000000000 --- a/.github/workflows/check_documentation_links.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Check Documentation Links - -on: - pull_request: - paths: - - "docs/**" - push: - branches: - - main - - doc-builder* - - v*-release - - v*-patch - paths: - - "docs/**" - workflow_dispatch: - -concurrency: - group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} - cancel-in-progress: true - -jobs: - check-links: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.10' - - - name: Install uv - run: | - curl -LsSf https://astral.sh/uv/install.sh | sh - echo "$HOME/.cargo/bin" >> $GITHUB_PATH - - - name: Install doc-builder - run: | - uv pip install --system git+https://github.com/huggingface/doc-builder.git@main - - - name: Check documentation links - run: | - uv run doc-builder check-links docs/source/en