mirror of
https://github.com/hwchase17/langchain.git
synced 2025-04-27 03:31:51 +00:00
108 lines
3.7 KiB
YAML
108 lines
3.7 KiB
YAML
name: API docs build
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
schedule:
|
|
- cron: '0 13 * * *'
|
|
env:
|
|
PYTHON_VERSION: "3.11"
|
|
|
|
jobs:
|
|
build:
|
|
if: github.repository == 'langchain-ai/langchain' || github.event_name != 'schedule'
|
|
runs-on: ubuntu-latest
|
|
permissions: write-all
|
|
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: Get repos 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 and checkout repos
|
|
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 that is in langchain-ai org
|
|
for repo in $REPOS; do
|
|
REPO_NAME=$(echo $repo | cut -d'/' -f2)
|
|
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 py deps
|
|
working-directory: langchain
|
|
run: |
|
|
python -m pip install -U uv
|
|
python -m uv pip install --upgrade --no-cache-dir pip setuptools pyyaml
|
|
|
|
- name: Move libs with script
|
|
run: python langchain/.github/scripts/prep_api_docs_build.py
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Rm old html
|
|
run:
|
|
rm -rf langchain-api-docs-html/api_reference_build/html
|
|
|
|
- name: Install 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: Set Git config
|
|
working-directory: langchain
|
|
run: |
|
|
git config --local user.email "actions@github.com"
|
|
git config --local user.name "Github Actions"
|
|
|
|
- name: Build docs
|
|
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'
|