From a3ba0dddd905ff6f351efb4d96b63aa1517b9df8 Mon Sep 17 00:00:00 2001 From: GratienDSX Date: Thu, 12 Dec 2024 11:13:09 +0100 Subject: [PATCH] Update docs CI/CD --- .github/workflows/ci-cd-mkdocs.yml | 99 +++++++++++++++--------------- 1 file changed, 51 insertions(+), 48 deletions(-) diff --git a/.github/workflows/ci-cd-mkdocs.yml b/.github/workflows/ci-cd-mkdocs.yml index ec6b9fa..337d0ae 100644 --- a/.github/workflows/ci-cd-mkdocs.yml +++ b/.github/workflows/ci-cd-mkdocs.yml @@ -1,49 +1,52 @@ --- -name: CI/CD for MkDocs -on: - push: - branches: - - main - pull_request: - types: - - opened - - synchronize - branches: - - main -jobs: - build: - if: ${{ github.actor != 'dependabot[bot]' }} - name: Build doc - runs-on: forge - steps: - - uses: actions/checkout@v4 - - name: Install Python - uses: actions/setup-python@v4 - with: - python-version: '3.11' - - name: Install package with optional dependency 'doc' - run: | - python -m pip install --upgrade pip - pip install .[doc] - - name: Run MkDocs build - working-directory: ./docs - run: mkdocs build - - name: Upload Pages artifact - uses: actions/upload-pages-artifact@v2 - with: - path: "docs/site/" - publish: - if: success() && github.ref == 'refs/heads/master' - name: Publish doc - needs: build - permissions: - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: forge - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v2 + name: Documentation CI/CD + on: + push: + branches: + - main + tags: + - '*' # Later: \b[0-9]\.[0-9]+\.[0-9]+[ab]?[0-9]?\b + pull_request: + types: + - opened + - synchronize + branches: + - main + + jobs: + build: + if: ${{ github.actor != 'dependabot[bot]' }} + name: Build doc + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install Python + uses: actions/setup-python@v5 + with: + python-version: '3.x' + - name: Install package with optional dependency 'doc' + run: | + python -m pip install --upgrade pip + pip install .[doc] + - name: Run MkDocs build + working-directory: ./docs + run: mkdocs build + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: "docs/site/" + publish: + if: success() && startsWith(github.ref, 'refs/tags') + name: Publish doc + needs: build + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file