Skip to content

Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

ci: check doc links only on edge and latest versions (#6633)

Lucas Gomideca5ef810bea1
diff --git a/.github/workflows/docs-broken-links.yml b/.github/workflows/docs-broken-links.yml
index e1b9aeb0e..4406b9001 100644
--- a/.github/workflows/docs-broken-links.yml
+++ b/.github/workflows/docs-broken-links.yml
@@ -4,13 +4,11 @@ on:
pull_request:
paths:
- "docs/**"
- - "docs.json"
push:
branches:
- main
paths:
- "docs/**"
- - "docs.json"
workflow_dispatch:
permissions:
@@ -28,11 +26,40 @@ jobs:
with:
node-version: "22"
- - name: Install Mintlify CLI
- run: npm i -g mintlify
+ - name: Install Mint CLI
+ run: npm i -g [email protected]
- - name: Run broken link checker
+ # Pruning immutable snapshots keeps the check fast (--files still parses every
+ # page); the default version must stay because unprefixed links resolve to it.
+ - name: Prune frozen doc versions (keep edge and latest)
+ if: github.event_name != 'workflow_dispatch'
run: |
- # Auto-answer the prompt with yes command
- yes "" | mintlify broken-links || test $? -eq 141
+ python3 - <<'EOF'
+ import json
+ import shutil
+ from pathlib import Path
+
+ docs = Path("docs")
+ spec_path = docs / "docs.json"
+ spec = json.loads(spec_path.read_text())
+
+ keep_dirs = {"edge"}
+ for lang in spec["navigation"]["languages"]:
+ kept = [v for v in lang["versions"] if v["version"] == "Edge" or v.get("default")]
+ lang["versions"] = kept
+ keep_dirs.update(v["version"] for v in kept if v["version"] != "Edge")
+
+ missing = [d for d in keep_dirs if not (docs / d).is_dir()]
+ if missing:
+ raise SystemExit(f"docs.json version labels do not match directories: {missing}")
+
+ spec_path.write_text(json.dumps(spec, indent=2))
+
+ for path in docs.glob("v*"):
+ if path.is_dir() and path.name not in keep_dirs:
+ shutil.rmtree(path)
+ EOF
+
+ - name: Run broken link checker
+ run: mint broken-links
working-directory: ./docs