docs: drop the e2e badge from README; the existing CI already covers … #50
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # SPDX-License-Identifier: Apache-2.0 | |
| name: docs | |
| # Build the MkDocs (Material) documentation site and deploy it to GitHub Pages. | |
| # This is the static docs site (hyukjinkwon.github.io/pyspark-client-wasm/); it is | |
| # SEPARATE from the JupyterLite app build (e2e.yml / scripts/build_site.sh) and | |
| # from ci.yml - neither is touched here. | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| # Allow only one concurrent deployment; let an in-progress run finish. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| # Least-privilege token; Pages deploy needs id-token (OIDC) + pages write. | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install MkDocs + Material | |
| run: | | |
| python -m pip install --upgrade pip | |
| # Pinned to a set verified to build cleanly. The older | |
| # mkdocs-material 9.5.49 / pymdown-extensions 10.14 triggered a | |
| # pygments HtmlFormatter crash (html.escape(None)) under --strict. | |
| python -m pip install \ | |
| "mkdocs==1.6.1" \ | |
| "mkdocs-material==9.7.6" \ | |
| "pymdown-extensions==10.21.3" \ | |
| "pygments==2.19.1" | |
| - name: Build site (strict) | |
| run: mkdocs build --strict | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |