docs: change logo used in project website #1230
Workflow file for this run
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
| name: CI Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| build-docs: | |
| name: "Build Docs" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install -e . | |
| python -m pip install ".[docs]" | |
| python -m pip install ibis-framework[duckdb] | |
| python -m pip install pins | |
| python -m pip install pandera | |
| python -m pip install patito | |
| python -m pip install validoopsie | |
| python -m pip install dataframely | |
| - name: Set up Quarto | |
| uses: quarto-dev/quarto-actions/setup@v2 | |
| - name: Build docs | |
| run: | | |
| make docs-build | |
| - name: Save docs artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-html | |
| path: docs/_site | |
| publish-docs: | |
| name: "Publish Docs" | |
| runs-on: ubuntu-latest | |
| needs: "build-docs" | |
| if: github.ref == 'refs/heads/main' | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: docs-html | |
| path: docs/_site | |
| - uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_site | |
| preview-docs: | |
| name: "Preview Docs" | |
| runs-on: ubuntu-latest | |
| needs: "build-docs" | |
| if: github.event_name == 'pull_request' | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: docs-html | |
| path: docs/_site | |
| # start deployment ---- | |
| - name: Configure pull release name | |
| if: ${{github.event_name == 'pull_request'}} | |
| run: | | |
| echo "RELEASE_NAME=pr-${PR_NUMBER}" >> $GITHUB_ENV | |
| env: | |
| PR_NUMBER: ${{ github.event.number }} | |
| - name: Configure branch release name | |
| if: ${{github.event_name != 'pull_request'}} | |
| run: | | |
| # use branch name, but replace slashes. E.g. feat/a -> feat-a | |
| echo "RELEASE_NAME=${GITHUB_REF_NAME/\//-}" >> $GITHUB_ENV | |
| # deploy ---- | |
| - name: Create Github Deployment | |
| uses: bobheadxi/deployments@v1 | |
| id: deployment | |
| if: ${{ !github.event.pull_request.head.repo.fork }} | |
| with: | |
| step: start | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| env: ${{ env.RELEASE_NAME }} | |
| ref: ${{ github.head_ref }} | |
| transient: true | |
| logs: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | |
| - name: Netlify docs preview | |
| if: ${{ !github.event.pull_request.head.repo.fork }} | |
| run: | | |
| npm install -g netlify-cli | |
| # push main branch to production, others to preview -- | |
| netlify link --name="$PREVIEW_SITE" | |
| if [ "${ALIAS}" == "main" ]; then | |
| netlify deploy --dir=docs/_site --alias="main" | |
| else | |
| netlify deploy --dir=docs/_site --alias="${ALIAS}" | |
| fi | |
| env: | |
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | |
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | |
| NETLIFY_SITE_NAME: ${{ secrets.NETLIFY_SITE_NAME }} | |
| ALIAS: ${{ steps.deployment.outputs.env }} | |
| - name: Update Github Deployment | |
| uses: bobheadxi/deployments@v1 | |
| if: ${{ !github.event.pull_request.head.repo.fork && always() }} | |
| with: | |
| step: finish | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| status: ${{ job.status }} | |
| env: ${{ steps.deployment.outputs.env }} | |
| env_url: "https://${{ steps.deployment.outputs.env }}--${{ secrets.NETLIFY_SITE_NAME }}.netlify.app" | |
| deployment_id: ${{ steps.deployment.outputs.deployment_id }} |