Skip to content

Fix hexdoc_smart_var docstring (was '!Variable', should be 'variable') #88

Fix hexdoc_smart_var docstring (was '!Variable', should be 'variable')

Fix hexdoc_smart_var docstring (was '!Variable', should be 'variable') #88

Workflow file for this run

name: Deploy docs
on:
push:
branches: main
permissions:
contents: read
env:
ALGOLIA_APP_ID: 80YMFEUQR0
ALGOLIA_CONFIG_PATH: web/docusaurus/algolia.json
jobs:
build:
runs-on: ubuntu-latest
outputs:
# TODO: can we disable this warning somehow? :/
run-scraper: ${{ steps.filter.outputs.docs }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- uses: yezz123/setup-uv@v4
- name: Install Nox
run: uv pip install --system nox
- name: Generate docs
timeout-minutes: 5
run: nox --tags docs -- build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: web/docusaurus/build
- name: Check if scraper should run
id: filter
uses: dorny/paths-filter@v3
with:
filters: |
docs:
- 'web/docusaurus/**'
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deploy-pages.outputs.page_url }}
steps:
- id: deploy-pages
uses: actions/deploy-pages@v4
run-scraper:
needs: [build, deploy]
if: ${{ needs.build.outputs.run-scraper == 'true' }}
runs-on: ubuntu-latest
environment:
name: algolia
steps:
- uses: actions/checkout@v4
- name: Load Algolia config
id: config
run: echo "config=$(cat ${{ env.ALGOLIA_CONFIG_PATH }} | jq -r tostring)" >> $GITHUB_OUTPUT
- name: Run DocSearch scraper
uses: signcl/docsearch-scraper-action@master
env:
APPLICATION_ID: ${{ env.ALGOLIA_APP_ID }}
API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
CONFIG: ${{ steps.config.outputs.config }}