From 460e70cc42fb56561c7eea72d8852044a5046590 Mon Sep 17 00:00:00 2001 From: "H. Joe Lee" Date: Wed, 27 Nov 2024 07:49:21 -0600 Subject: [PATCH] Add check for broken links in Doxygen generated html docs (#5138) --- .github/workflows/linkchecker.yml | 46 +++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/workflows/linkchecker.yml diff --git a/.github/workflows/linkchecker.yml b/.github/workflows/linkchecker.yml new file mode 100644 index 00000000000..d6a861d7bf7 --- /dev/null +++ b/.github/workflows/linkchecker.yml @@ -0,0 +1,46 @@ +name: linkchecker + +on: + workflow_dispatch: + push: + pull_request: + branches: [ develop ] + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref && github.ref || github.run_id }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: get + uses: actions/checkout@v4 + + - name: install + run: | + sudo apt update -y + sudo apt install -y libunwind-dev + sudo apt install -y graphviz + sudo apt install -y --no-install-recommends doxygen + sudo apt install -y cmake + sudo apt install -y texlive-full + sudo apt install -y texlive-fonts-extra + sudo apt install -y texlive-latex-extra + pip3 install linkchecker + + - name: build + run: | + mkdir build + cd build + cmake -DHDF5_BUILD_DOC:BOOL=ON .. + make doxygen + + - name: check + run: | + cd build/hdf5lib_docs/html + linkchecker --check-extern ./index.html +