Build & Deploy API Reference #16
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: '📚 API Docs' | |
| run-name: 'Build & Deploy API Reference' | |
| # Runs daily or can be triggered manually for immediate updates | |
| on: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '0 13 * * *' # Daily at 1PM UTC | |
| env: | |
| PYTHON_VERSION: "3.11" | |
| jobs: | |
| # Only runs on main repository to prevent unnecessary builds on forks | |
| build: | |
| if: github.repository == 'langchain-ai/langchain' || github.event_name != 'schedule' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: langchain | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: langchain-ai/langchain-api-docs-html | |
| path: langchain-api-docs-html | |
| token: ${{ secrets.TOKEN_GITHUB_API_DOCS_HTML }} | |
| - name: '📋 Extract Repository List with yq' | |
| id: get-unsorted-repos | |
| uses: mikefarah/yq@master | |
| with: | |
| cmd: | | |
| yq ' | |
| .packages[] | |
| | select( | |
| ( | |
| (.repo | test("^langchain-ai/")) | |
| and | |
| (.repo != "langchain-ai/langchain") | |
| ) | |
| or | |
| (.include_in_api_ref // false) | |
| ) | |
| | .repo | |
| ' langchain/libs/packages.yml | |
| - name: '📋 Parse YAML & Checkout Repositories' | |
| env: | |
| REPOS_UNSORTED: ${{ steps.get-unsorted-repos.outputs.result }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| # Get unique repositories | |
| REPOS=$(echo "$REPOS_UNSORTED" | sort -u) | |
| # Checkout each unique repository | |
| for repo in $REPOS; do | |
| # Validate repository format (allow any org with proper format) | |
| if [[ ! "$repo" =~ ^[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+$ ]]; then | |
| echo "Error: Invalid repository format: $repo" | |
| exit 1 | |
| fi | |
| REPO_NAME=$(echo $repo | cut -d'/' -f2) | |
| # Additional validation for repo name | |
| if [[ ! "$REPO_NAME" =~ ^[a-zA-Z0-9_.-]+$ ]]; then | |
| echo "Error: Invalid repository name: $REPO_NAME" | |
| exit 1 | |
| fi | |
| echo "Checking out $repo to $REPO_NAME" | |
| git clone --depth 1 https://github.com/$repo.git $REPO_NAME | |
| done | |
| - name: '🐍 Setup Python ${{ env.PYTHON_VERSION }}' | |
| uses: actions/setup-python@v5 | |
| id: setup-python | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: '📦 Install Initial Python Dependencies' | |
| working-directory: langchain | |
| run: | | |
| python -m pip install -U uv | |
| python -m uv pip install --upgrade --no-cache-dir pip setuptools pyyaml | |
| - name: '📦 Organize Library Directories' | |
| run: python langchain/.github/scripts/prep_api_docs_build.py | |
| - name: '🧹 Remove Old HTML Files' | |
| run: | |
| rm -rf langchain-api-docs-html/api_reference_build/html | |
| - name: '📦 Install Documentation Dependencies' | |
| working-directory: langchain | |
| run: | | |
| python -m uv pip install $(ls ./libs/partners | xargs -I {} echo "./libs/partners/{}") --overrides ./docs/vercel_overrides.txt | |
| python -m uv pip install libs/core libs/langchain libs/text-splitters libs/community libs/experimental libs/standard-tests | |
| python -m uv pip install -r docs/api_reference/requirements.txt | |
| - name: '🔧 Configure Git Settings' | |
| working-directory: langchain | |
| run: | | |
| git config --local user.email "actions@github.com" | |
| git config --local user.name "Github Actions" | |
| - name: '📚 Build API Documentation' | |
| working-directory: langchain | |
| run: | | |
| python docs/api_reference/create_api_rst.py | |
| python -m sphinx -T -E -b html -d ../langchain-api-docs-html/_build/doctrees -c docs/api_reference docs/api_reference ../langchain-api-docs-html/api_reference_build/html -j auto | |
| python docs/api_reference/scripts/custom_formatter.py ../langchain-api-docs-html/api_reference_build/html | |
| # Default index page is blank so we copy in the actual home page. | |
| cp ../langchain-api-docs-html/api_reference_build/html/{reference,index}.html | |
| rm -rf ../langchain-api-docs-html/_build/ | |
| # https://github.com/marketplace/actions/add-commit | |
| - uses: EndBug/add-and-commit@v9 | |
| with: | |
| cwd: langchain-api-docs-html | |
| message: 'Update API docs build' |