fix(docs): add null examples header and expected failure #3789
Workflow file for this run
This file contains 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
| name: Docs Preview | |
| on: | |
| pull_request_target: | |
| types: | |
| - labeled | |
| jobs: | |
| docs_preview: | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }}-${{ github.event.label.name }} | |
| cancel-in-progress: true | |
| if: github.event.label.name == 'docs-preview' | |
| steps: | |
| - uses: actions/[email protected] | |
| id: generate_token | |
| with: | |
| app-id: ${{ secrets.DOCS_BOT_APP_ID }} | |
| private-key: ${{ secrets.DOCS_BOT_APP_PRIVATE_KEY }} | |
| - name: reset label | |
| uses: actions-ecosystem/action-remove-labels@v1 | |
| with: | |
| labels: docs-preview | |
| github_token: ${{ steps.generate_token.outputs.token }} | |
| - name: install nix | |
| uses: cachix/install-nix-action@v30 | |
| with: | |
| extra_nix_config: | | |
| access-tokens = github.com=${{ steps.generate_token.outputs.token }} | |
| - name: setup cachix | |
| uses: cachix/cachix-action@v15 | |
| with: | |
| name: ibis | |
| authToken: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| extraPullNames: nix-community | |
| - name: checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - name: generate url alias | |
| id: get_alias | |
| run: | | |
| echo "id=pr-${{ github.event.pull_request.number }}-${{ github.event.pull_request.head.sha }}" >> "$GITHUB_OUTPUT" | |
| - name: Get all changed qmd files | |
| id: changed-qmd-files | |
| uses: tj-actions/changed-files@v45 | |
| with: | |
| # Avoid using single or double quotes for multiline patterns | |
| files: | | |
| **.qmd | |
| - name: get preview links | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-qmd-files.outputs.all_changed_files }} | |
| PREVIEW_URL: "https://${{ steps.get_alias.outputs.id }}--ibis-quarto.netlify.app" | |
| run: | | |
| { | |
| echo 'Docs preview: https://${{ steps.get_alias.outputs.id }}--ibis-quarto.netlify.app' | |
| for file in ${ALL_CHANGED_FILES}; do | |
| link="${file#docs/}" | |
| echo "- [${file}](${PREVIEW_URL}/${link%.qmd})" | |
| done | |
| } | tee /tmp/comment | |
| - name: restore cache of the previously rendered notebooks | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: docs-${{ github.event.pull_request.base.sha }} | |
| path: docs/**/.jupyter_cache | |
| - name: run quarto check | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME -c quarto check | |
| - name: build docs | |
| run: nix develop '.#ibis311' --ignore-environment --keep HOME -c just docs-build-all | |
| - name: install netlify cli | |
| run: npm install -g netlify-cli | |
| - name: build and push quarto docs to preview url | |
| run: netlify deploy --dir=docs/_output --alias="${{ steps.get_alias.outputs.id }}" | |
| env: | |
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | |
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | |
| - name: create preview link comment | |
| if: success() | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| token: ${{ steps.generate_token.outputs.token }} | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body-path: /tmp/comment |