From f47c37d04674d3bebbe7412bc4bebfe7be4e1201 Mon Sep 17 00:00:00 2001 From: Toby Bellwood Date: Wed, 27 Mar 2024 11:41:50 +1100 Subject: [PATCH] test: add mkdocs github action --- .github/workflows/test-mkdocs.yml | 38 +++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/test-mkdocs.yml diff --git a/.github/workflows/test-mkdocs.yml b/.github/workflows/test-mkdocs.yml new file mode 100644 index 0000000000..463b9f7860 --- /dev/null +++ b/.github/workflows/test-mkdocs.yml @@ -0,0 +1,38 @@ +name: Test mkdocs +on: + push: + branches: + - 'docs/**' + pull_request: + branches: + - 'main' + paths: + - 'docs/**' + - 'mkdocs.yml' + - '.github/workflows/test-mkdocs.yml' + +jobs: + mkdocs: + runs-on: ubuntu-latest + steps: + - + name: Checkout PR + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - + name: Install mkdocs and dependencies + run: | + pip install --upgrade pip + pip install mkdocs + pip install -r docs/requirements.txt + - + name: Check docs build ok in native mkdocs + run: | + mkdocs -V + mkdocs build -s + - + name: Check docs build ok with amazee.io mkdocs image + run: | + docker run --rm ghcr.io/amazeeio/mkdocs-material -V + docker run --rm -p 8000:8000 -v ${PWD}:/docs ghcr.io/amazeeio/mkdocs-material build -s