ci[minor]: Add GitHub action to check broken links #8
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: Check Docs & Links | |
on: | |
push: | |
branches: ["main"] | |
pull_request: | |
paths: | |
- '**.ipynb' | |
schedule: | |
- cron: "0 5 * * *" | |
workflow_dispatch: | |
env: | |
POETRY_VERSION: "1.7.1" | |
jobs: | |
markdown-link-check: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Check links in Markdown files | |
uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
with: | |
folder-path: "examples/,docs/" | |
check-modified-files-only: ${{ github.event_name != 'schedule' }} | |
file-path: "./README.md" | |
config-file: "./.markdown-link-check.config.json" | |
notebook-link-check: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Set up Node.js | |
uses: actions/setup-node@v3 | |
with: | |
node-version: '16.x' | |
cache: 'yarn' | |
- name: Install dependencies | |
run: | | |
yarn install --frozen-lockfile | |
- name: Check links in notebooks | |
env: | |
LANGCHAIN_API_KEY: test | |
run: | | |
echo "Fetching changes from origin/main..." | |
git fetch origin main | |
echo "Checking for changed notebook files..." | |
CHANGED_FILES=$(git diff --name-only --diff-filter=d origin/main | grep '\.ipynb$' || true) | |
echo "Changed files: ${CHANGED_FILES}" | |
if [ -n "${CHANGED_FILES}" ]; then | |
echo "Running link check on changed notebook files..." | |
yarn add pytest | |
yarn run pytest -v --check-links-ignore "https://(api|web)\.smith\.langchain\.com/.*" --check-links-ignore "https://x.com/.*" --check-links ${CHANGED_FILES} || ([ $? = 5 ] && exit 0 || exit $?) | |
else | |
echo "No notebook files changed." | |
fi |